node package manager

gun

gun

npm Travis Gitter FOSSA Status

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

Warning: We're merging 0.5 branch into Master, you may experience some hiccups - please report them!

Why?

  • Realtime - It may be trivial to get realtime updates with socket.io or something, but what you do not get is state synchronization. GUN does this for you out of the box, assuring that two users' simultaneous updates won't concurrently break each other.
  • 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 this "NoDB". From that, 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 run the NodeJS examples npm install gun && 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="http://rawgit.com/amark/gun/master/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> 

Support

Documentation

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.

Videos

Projects

Modules

GUN is designed to be as minimal as possible, with any additional functionality being provided via modules. Please refer to the modules page for a list of existing extensions. Please refer to the gun-extensions repo to see what extensions have been requested or to request an extension.

How can I help make gun even more awesome?

License

Designed with ♥ by Mark Nadal, the gun team, and many amazing contributors. Liberally licensed under Zlib / MIT / Apache 2.0.

FOSSA Status

Contributors

Thanks to the following people who have contributed to GUN, via code, issues, or conversation (this list has quickly become tremendously behind! We'll probably turn this into a dedicated wiki page so you can add yourself):

agborkowski; ⭐️alanmimms; alexlafroscia; anubiann00b; BrockAtkinson (brunch config); bromagosa; Brysgo (GraphQL); coolaj86; d-oliveros, danscan; forrestjt (file.js); gedw99; HelloCodeMing; JosePedroDias (graph visualizer); JuniperChicago (cycle.js bindings); jveres (todoMVC); kristianmandrup (edge); ndarilek; onetom; phpnode; PsychoLlama; RangerMauve (schema); robertheessels (gun-p2p-auth); riston; rootsical; rrrene; sbeleidy; ⭐️Sean Matheson (Observable/RxJS/Most.js bindings); ssr1ram; Stefdv (Polymer/web components); sjones6 (VueJS); Xe; zot; ayurmedia;

This list of contributors was manually compiled and alphabetically sorted. If we missed you, please submit an issue so we can get you added!

Changelog

Also see the current Release List and Tag List for quick access to relevant versions.

Gitter channel YouTube LinkedIn Twitter Follow