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 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.

• An online demo of the examples are available here: http://gunjs.herokuapp.com/
• Or write a quick app: (try now in jsbin)

<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: "[email protected]",
});

gun.get('mark').on(function(data, key){
  console.log("update:", data);
});
</script>

Support

• Help support development: https://www.patreon.com/gunDB !
• Ask questions: http://stackoverflow.com/questions/tagged/gun ?
• Chat with us: https://gitter.im/amark/gun .

Documentation

• API reference.
• A must read crash course on using GUN.
• Introductory Guide.
• What tradeoffs does GUN make? It is an AP system, so banking apps aren't a good fit.
• How the Conflict Resolution algorithm works.
• Check out and add example code snippets —including micro-modules— to address specific situations.
• Loose roadmap.
• A React tutorial.
• See this module for GraphQL support.
• A React example.
• An Angular example.
• Some VueJS examples.

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

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

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

• Fault tolerance (01:01)
• Saving relational or document based data (06:59)
• Everything you want to know about GUN (57:50) 1.25x speed recommended.
• GUN's YouTube channel also has videos.

Projects

• GUN users are encouraged to add their projects to this running projects list.

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?

• Star this repo
• Follow us and share your appreciation via Gitter, Twitter, LinkedIn, and Facebook
• Share projects you've written
• Build extensions or squish bugs - If you are working on an extension, familiarize yourself with GUN's Module API

License

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

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; ⭐Dan Dombrowsky; 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; ⭐samliu; 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.