- 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.
- 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
- An online demo of the examples are available here: http://gunjs.herokuapp.com/
- Or write a quick app: (try now in jsbin)
// var Gun = require('gun'); // in NodeJS
// var Gun = require('gun/gun'); // in React
var gun = Gun();
email: "[email protected]",
- See this module for GraphQL support.
What tradeoffs does GUN make? It is an AP system, so banking apps aren’t a good fit.
Check out and add example code snippets) —including micro-modules— to address specific situations.
bash npm install -g now now --npm amark/gunThen visit the URL in the output of the ‘now –npm’ step, in your browser.
Pull from the Docker Hub . Or:
bash docker run -p 8080:8080 gundb/gunOr build the Docker image locally:
bash git clone https://github.com/amark/gun.git cd gun docker build -t myrepo/gundb:v1 . docker run -p 8080:8080 myrepo/gundb:v1Or, if you prefer your Docker image with metadata labels (Linux/Mac only):
bash npm run docker docker run -p 8080:8080 usenameHere/gun:gitThen visit http://localhost:8080 in your browser.
Fault tolerance (01:01)
Everything you want to know about GUN (57:50) 1.25x speed recommended.
GUN’s YouTube channel also has videos.
GUN users are encouraged to add their projects to this running projects list.
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
Designed with ♥ by Mark Nadal, the gun team, and many amazing contributors. Liberally licensed under Zlib / MIT / Apache 2.0.
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; :star: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; :star: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!