GUN is an ecosystem of tools that let you build community run and encrypted applications.
Currently, Internet Archive and HackerNoon run GUN in production.
The ecosystem is one nice stack of technologies that looks like this: (names -> use case)
For now, it is best to start with GUN and just use it to learn the basics, since it is so easy: (or want to read more? Skip ahead to the "What is GUN?" section.)
- Try the interactive tutorial in the browser (5min ~ average developer).
npm install gunand run the examples with
cd node_modules/gun && npm start(5min ~ average developer).
- An online demo of the examples are available here: http://gunjs.herokuapp.com/
- Or write a quick app: (try now in jsbin)
- 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;catslave = mark;// partial updates merge with existing data!gun;// access the data as if it is a document.gun;// traverse a graph of circular references!gun;// add both of them to a table!gun;gun;// grab each item once from the table, continuously:gun;// live update the table!gun;
Want to keep building more? Jump to THE DOCUMENTATION!
What is GUN?
First & foremost, GUN is a community of the nicest and most helpful people out there. So I want to invite you to come tell us about what you are working on & wanting to build (new or old school alike! Just be nice as well.) and ask us your questions directly. :)
On that note, let's get some official shout outs covered first:
Robert Heessels, Lorenzo Mangani, NLnet Foundation, Sam Liu, Daniel Dombrowsky, Vincent Woo, AJ ONeal, Bill Ottman, Mike Lange, Sean Matheson, Alan Mimms, Dário Freire, John Williamson, Robin Bron, Elie Makhoul, Mike Staub
- Join others in sponsoring code: https://www.patreon.com/gunDB !
- Ask questions: http://stackoverflow.com/questions/tagged/gun ?
- Found a bug? Report at: https://github.com/amark/gun/issues ;
- Need help? Chat with us: https://gitter.im/amark/gun .
After he realized Master-Slave database architecture causes one big bottleneck, he (as a complete newbie outsider) naively decided to question the status quo and shake things up with controversial, heretical, and contrarian experiments:
The NoDB - no master, no servers, no "single source of truth", not built with a real programming language or real hardware, no DevOps, no locking, not just SQL or NoSQL but both (all - graphs, documents, tables, key/value).
The goal was to build a P2P database that could survive living inside any browser, and could correctly sync data between any device after assuming any offline-first activity.
Technically, GUN is a graph synchronization protocol with a lightweight embedded engine, capable of doing 20M+ API ops/sec in just ~9KB gzipped size.
This would not be possible without community contributors, big shout out to:
ajmeyghani (Learn GUN Basics with Diagrams); anywhichway (Block Storage); beebase (Quasar); BrockAtkinson (brunch config); Brysgo (GraphQL); d3x0r (SQLite); forrestjt (file.js); hillct (Docker); JosePedroDias (graph visualizer); JuniperChicago (cycle.js bindings); jveres (todoMVC); kristianmandrup (edge); Lightnet (Awesome Vue User Examples & User Kitchen Sink Playground); lmangani (Cytoscape Visualizer, Cassandra, Fastify, LetsEncrypt); mhelander (SEA); omarzion (Sticky Note App); PsychoLlama (LevelDB); RangerMauve (schema); robertheessels (gun-p2p-auth); rogowski (AXE); sbeleidy; sbiaudet (C# Port); Sean Matheson (Observable/RxJS/Most.js bindings); Shadyzpop (React Native example); sjones6 (Flint); Stefdv (Polymer/web components); zrrrzzt (JWT Auth); xmonader (Python Port);
I am missing many others, apologies, will be adding them soon!
Tests may be run with
npm test. Tests will trigger persistent writes to the DB, so subsequent runs of the test will fail. You must clear the DB before running the tests again. This can be done by running the following command in the project directory.
rm -rf *data*
Additional Cryptography Libraries
To install with npm, first install
npm install gun -S.
For just the networking layer, import Gun:
var Gun = ;
If you also need to install SEA for user auth and crypto, also install some of its dependencies like this:
npm install text-encoding @peculiar/webcrypto --save
You will need to require it too (it will be automatically added to the Gun object):
var Gun = ;var Sea = ;
Heroku deletes your data every 15 minutes, one way to fix this is by adding cheap storage.
git clone https://github.com/amark/gun.gitcd gunheroku creategit push -f heroku HEAD:master
Then visit the URL in the output of the 'heroku create' step, in a browser.
npm install -g nownow --npm amark/gun
Then visit the URL in the output of the 'now --npm' step, in your browser.
Fork this GUN repo (Unebo only deploys from your own GitHub repo's).
Add a Node.js app, select your GUN fork, set
npm start start as the command and deploy.
Then visit the deployed app by following the 'view app' button, in your browser.
Pull from the Docker Hub . Or:
docker run -p 8765:8765 gundb/gun
Or build the Docker image locally:
git clone https://github.com/amark/gun.gitcd gundocker build -t myrepo/gundb:v1 .docker run -p 8765:8765 myrepo/gundb:v1
Or, if you prefer your Docker image with metadata labels (Linux/Mac only):
npm run dockerdocker run -p 8765:8765 username/gun:git
Then visit http://localhost:8765 in your browser.
Designed with ♥ by Mark Nadal, the GUN team, and many amazing contributors.
Openly licensed under Zlib / MIT / Apache 2.0.