gun

GUN is a realtime, distributed, offline-first, graph database engine.

But what makes gun awesome?

• Realtime - GUN shares data across connected peers in real-time. There's no need for plugins, extensions, or anything else, just use gun as directed and enjoy realtime data sharing.
• Distributed - GUN is peer-to-peer by design and doesn't rely on a central data server. This results in all kinds of data deliciousness, including being able to work offline by default. Peers can be configured into more traditional centralized or federated systems, as appropriate for application needs.
• Graph - All data in gun is encapsulated as nodes in a graph. Graphs allow data to be related in traditional table formats, as well as tree format, and circular formats. In other words, gun lets your data needs determine your data storage structure.

Table of Contents

• Demos
  • Videos
  • Projects
• How to get started
• Modules
• How can I help make gun even more awesome?
• License
  • Contributors
• Changelog
• Stay up-to-date
• API Reference ↗️

Demos

• Online example applications

• The above examples are included in this repo. You can run them locally by running the following commands in your terminal or on your command line:

  Note: If you don't have node or npm, read this first.

  npm install gun
  cd node_modules/gun
  node examples/http.js 8080

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

  If that did not work it is probably because npm installed it to a global directory. To fix that try mkdir node_modules in your desired directory and re-run the above commands. You also might have to add sudo in front of the commands.

Videos

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

Projects

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

How to get started

• Until we complete the Getting Started with GUN Guide, please review the API documentation and examples' source code.
• Check out and add example code snippets —including micro-modules— to address specific situations.

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; alexlafroscia; anubiann00b; bromagosa; coolaj86; d-oliveros, danscan; forrestjt (file.js); gedw99; HelloCodeMing; JosePedroDias (graph visualizer); jveres (todoMVC live demo); ndarilek; onetom; phpnode; PsychoLlama; RangerMauve (schema); riston; rootsical; rrrene; ssr1ram; 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.

==========================