node package manager
Easy collaboration. Discover, share, and reuse code in your team. Create a free org »

gun

npm Travis FOSSA Status Gitter

GUN is a realtime, distributed, offline-first, graph database engine. Doing 20M+ ops/sec in just ~9KB gzipped.

Why?

  • Realtime - You might use socketio for realtime updates, but what happens if you reload the page? GUN solves state synchronization for you, no matter what, on reloads, across all your users, and even on conflicting updates.
  • Distributed - GUN is peer-to-peer by design, meaning you have no centralized database server to maintain or that could crash. This lets you sleep through the night without worrying about database DevOps - we call it "NoDB". From there, you can build decentralized, federated, or centralized apps.
  • Offline-first - GUN works even if your internet or cell reception doesn't. Users can still plug away and save data as normal, and then when the network comes back online GUN will automatically synchronize all the changes and handle any conflicts for you.
  • Graph - Most databases force you to bend over backwards to match their storage constraints. But graphs are different, they let you have any data structure you want. Whether that be traditional tables with relations, document oriented trees, or tons of circular references. You choose.

Quickstart

  • Try the interactive tutorial in the browser (5min ~ average developer).
  • Or npm install gun and run the examples with cd node_modules/gun && npm start (5min ~ average developer).

Note: If you don't have node or npm, read this first. If the npm command line didn't work, you may need to mkdir node_modules first or use sudo.

<script src="https://cdn.jsdelivr.net/npm/gun/gun.js"></script>
<script>
// var Gun = require('gun'); // in NodeJS
// var Gun = require('gun/gun'); // in React
var gun = Gun();
 
gun.get('mark').put({
  name: "Mark",
  email: "mark@gunDB.io",
});
 
gun.get('mark').on(function(data, key){
  console.log("update:", data);
});
</script> 
  • Or try something mind blowing, like saving circular references to a table of documents! (play)
var cat = {name: "Fluffy", species: "kitty"};
var mark = {boss: cat};
cat.slave = mark;
 
// partial updates merge with existing data!
gun.get('mark').put(mark);
 
// access the data as if it is a document.
gun.get('mark').get('boss').get('name').val(function(data, key){
  // `val` grabs the data once, no subscriptions.
  console.log("Mark's boss is", data);
});
 
// traverse a graph of circular references!
gun.get('mark').get('boss').get('slave').val(function(data, key){
  console.log("Mark is the slave!", data);
});
 
// add both of them to a table!
gun.get('list').set(gun.get('mark').get('boss'));
gun.get('list').set(gun.get('mark'));
 
// grab each item once from the table, continuously:
gun.get('list').map().val(function(data, key){
  console.log("Item:", data);
});
 
// live update the table!
gun.get('list').set({type: "cucumber", goal: "scare cat"});

Support

Thanks to:

Sam Liu, Daniel Dombrowsky, Vincent Woo, AJ ONeal, Bill Ottman, Sean Matheson, Alan Mimms

Documentation

API reference

Tutorials

Examples

GraphQL

Electron

Native

Vue

React

Webcomponents

CAP Theorem Tradeoffs

How Data Sync Works

How GUN is Built

Crypto Auth

Modules

Roadmap

This would not be possible without community contributors, big shout out to:

BrockAtkinson (brunch config); Brysgo (GraphQL); d3x0r (SQLite); forrestjt (file.js); hillct (Docker); JosePedroDias (graph visualizer); JuniperChicago (cycle.js bindings); jveres (todoMVC); kristianmandrup (edge); PsychoLlama (LevelDB); RangerMauve (schema); robertheessels (gun-p2p-auth); sbeleidy; Sean Matheson (Observable/RxJS/Most.js bindings); Stefdv (Polymer/web components); sjones6 (Flint);

I am missing many others, apologies, will be adding them soon!

Deploy

To quickly spin up a Gun test server for your development team, utilize either Heroku or Docker or any variant thereof Dokku, Flynn.io, now.sh, etc. !

Heroku

Deploy

Or:

git clone https://github.com/amark/gun.git
cd gun
heroku create
git push -f heroku HEAD:master

Then visit the URL in the output of the 'heroku create' step, in a browser.

Now.sh

npm install -g now
now --npm amark/gun

Then visit the URL in the output of the 'now --npm' step, in your browser.

Docker

Docker Automated buil Docker Pulls Docker Stars

Pull from the Docker Hub . Or:

docker run -p 8080:8080 gundb/gun

Or build the Docker image locally:

git clone https://github.com/amark/gun.git
cd gun
docker build -t myrepo/gundb:v1 .
docker run -p 8080:8080 myrepo/gundb:v1

Or, if you prefer your Docker image with metadata labels (Linux/Mac only):

npm run docker
docker run -p 8080:8080 usenameHere/gun:git

Then visit http://localhost:8080 in your browser.

License

Designed with ♥ by Mark Nadal, the GUN team, and many amazing contributors.

Openly licensed under Zlib / MIT / Apache 2.0.

FOSSA Status

YouTube . Twitter