{"id":13394352,"url":"https://github.com/amark/gun","last_synced_at":"2025-05-12T16:28:02.530Z","repository":{"id":19240088,"uuid":"22475123","full_name":"amark/gun","owner":"amark","description":"An open source cybersecurity protocol for syncing decentralized graph data.","archived":false,"fork":false,"pushed_at":"2025-04-02T16:36:23.000Z","size":33459,"stargazers_count":18411,"open_issues_count":308,"forks_count":1185,"subscribers_count":319,"default_branch":"master","last_synced_at":"2025-05-05T11:48:29.984Z","etag":null,"topics":["artificial-intelligence","big-data","blockchain","crdt","crypto","cryptography","dapp","database","decentralized","dweb","encryption","end-to-end","graph","machine-learning","metaverse","offline-first","p2p","protocol","realtime","web3"],"latest_commit_sha":null,"homepage":"https://gun.eco/docs","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"pineapplethief/redmine_issue_tabs","license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/amark.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"amark","patreon":"gunDB","open_collective":"gun","ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2014-07-31T15:52:10.000Z","updated_at":"2025-05-04T17:32:33.000Z","dependencies_parsed_at":"2023-01-13T20:15:12.121Z","dependency_job_id":"1bca30fc-ba7b-446c-a86a-b26ebe6d4c67","html_url":"https://github.com/amark/gun","commit_stats":{"total_commits":1966,"total_committers":162,"mean_commits":"12.135802469135802","dds":0.5142421159715158,"last_synced_commit":"03735dc09cf760ec9283076667d23b9076340742"},"previous_names":[],"tags_count":34,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amark%2Fgun","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amark%2Fgun/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amark%2Fgun/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amark%2Fgun/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/amark","download_url":"https://codeload.github.com/amark/gun/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252504165,"owners_count":21758654,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["artificial-intelligence","big-data","blockchain","crdt","crypto","cryptography","dapp","database","decentralized","dweb","encryption","end-to-end","graph","machine-learning","metaverse","offline-first","p2p","protocol","realtime","web3"],"created_at":"2024-07-30T17:01:16.799Z","updated_at":"2025-05-05T12:57:04.637Z","avatar_url":"https://github.com/amark.png","language":"JavaScript","readme":"\u003cp id=\"readme\"\u003e\u003ca href=\"https://gun.eco/\"\u003e\u003cimg width=\"40%\" src=\"https://cldup.com/TEy9yGh45l.svg\"/\u003e\u003c/a\u003e\u003cimg width=\"50%\" align=\"right\" vspace=\"25\" src=\"https://gun.eco/see/demo.gif\"/\u003e\u003c/p\u003e\r\n\r\n[![](https://data.jsdelivr.com/v1/package/npm/gun/badge)](https://www.jsdelivr.com/package/npm/gun)\r\n![Build](https://github.com/amark/gun/actions/workflows/ci.yml/badge.svg)\r\n[![Gitter](https://img.shields.io/gitter/room/amark/gun.js.svg)](http://chat.gun.eco)\r\n\r\n**GUN** is an [ecosystem](https://gun.eco/docs/Ecosystem) of **tools** that let you build [community run](https://www.nbcnews.com/tech/tech-news/these-technologists-think-internet-broken-so-they-re-building-another-n1030136) and [encrypted applications](https://gun.eco/docs/Cartoon-Cryptography) - like an Open Source Firebase or a Decentralized Dropbox.\r\n\r\nThe [Internet Archive](https://news.ycombinator.com/item?id=17685682) and [100s of other apps](https://github.com/amark/gun/wiki/awesome-gun) run GUN in-production.\r\n\r\n + Multiplayer by default with realtime p2p state synchronization!\r\n + Graph data lets you use key/value, tables, documents, videos, \u0026 more!\r\n + Local-first, offline, and decentralized with end-to-end encryption.\r\n\r\nDecentralized alternatives to [Zoom](https://www.zdnet.com/article/era-hatches-meething-an-open-source-browser-based-video-conferencing-system/), [Reddit](https://notabug.io/t/whatever/comments/36588a16b9008da4e3f15663c2225e949eca4a15/gpu-bot-test), [Instagram](https://iris.to/), [Slack](https://iris.to/), [YouTube](https://d.tube/), [Stripe](https://twitter.com/marknadal/status/1422717427427647489), [Wikipedia](https://news.ycombinator.com/item?id=17685682), Facebook [Horizon](https://twitter.com/marknadal/status/1424476179189305347) and more have already pushed terabytes of daily P2P traffic on GUN. We are a [friendly community](http://chat.gun.eco/) creating a [free fun future for freedom](https://youtu.be/1HJdrBk3BlE):\r\n\r\n\u003ctable\u003e\r\n\u003ctr\u003e\r\n\u003ca href=\"https://youtu.be/s_m16-w6bBI\"\u003e\u003cimg width=\"31%\" src=\"https://gun.eco/see/3dvr.gif\" title=\"3D VR\"/\u003e\u003c/a\u003e\r\n\u003ca href=\"https://github.com/cstefanache/cstefanache.github.io/blob/06697003449e4fc531fd32ee068bab532976f47b/_posts/2016-08-02-gun-db-artificial-knowledge-sharing.md\"\u003e\u003cimg width=\"31%\" src=\"https://gun.eco/see/aiml.gif\" title=\"AI/ML\"/\u003e\u003c/a\u003e\r\n\u003ca href=\"http://gps.gunDB.io/\"\u003e\u003cimg width=\"31%\" src=\"https://gun.eco/see/gps.gif\" title=\"GPS\"/\u003e\u003c/a\u003e\r\n\u003c/tr\u003e\r\n\u003ctr\u003e\r\n\u003ca href=\"https://github.com/lmangani/gun-scape#gun-scape\"\u003e\u003cimg width=\"31%\" src=\"https://gun.eco/see/dataviz.gif\" title=\"Data Viz\"/\u003e\u003c/a\u003e\r\n\u003ca href=\"https://github.com/amark/gun/wiki/Auth\"\u003e\u003cimg width=\"31%\" src=\"https://gun.eco/see/p2p.gif\" title=\"P2P\"/\u003e\u003c/a\u003e\r\n\u003ca href=\"https://github.com/Stefdv/gun-ui-lcd#okay-what-about-gundb-\"\u003e\u003cimg width=\"31%\" src=\"https://gun.eco/see/iot.gif\" title=\"IoT\"/\u003e\u003c/a\u003e\r\n\u003c/tr\u003e\r\n\u003ctr\u003e\r\n\u003ca href=\"http://chat.gun.eco\"\u003e\u003cimg width=\"31%\" src=\"https://gun.eco/see/vr-world.gif\" title=\"VR World\"/\u003e\u003c/a\u003e\r\n\u003ca href=\"https://youtu.be/1ASrmQ-CwX4\"\u003e\u003cimg width=\"31%\" src=\"https://gun.eco/see/ar.gif\" title=\"AR\"/\u003e\u003c/a\u003e\r\n\u003ca href=\"https://meething.space/\"\u003e\u003cimg width=\"31%\" src=\"https://gun.eco/see/video-conf.gif\" title=\"Video Confernece\"/\u003e\u003c/a\u003e\r\n\u003c/tr\u003e\r\n\u003c/table\u003e\r\n\r\n## Quickstart\r\n\r\nGUN is *super easy* to get started with:\r\n\r\n - Try the [interactive tutorial](https://gun.eco/docs/Todo-Dapp) in the browser (**5min** ~ average developer).\r\n - Or `npm install gun` and run the examples with `cd node_modules/gun \u0026\u0026 npm start` (**5min** ~ average developer).\r\n\r\n\u003e **Note:** If you don't have [node](http://nodejs.org/) or [npm](https://www.npmjs.com/), read [this](https://github.com/amark/gun/blob/master/examples/install.sh) first.\r\n\u003e If the `npm` command line didn't work, you may need to `mkdir node_modules` first or use `sudo`.\r\n\r\n- An online demo of the examples are available here: http://try.axe.eco/\r\n- Or write a quick app: ([try now in a playground](https://jsbin.com/kadobamevo/edit?js,console))\r\n```html\r\n\u003cscript src=\"https://cdn.jsdelivr.net/npm/gun/gun.js\"\u003e\u003c/script\u003e\r\n\u003cscript\u003e\r\n// import GUN from 'gun'; // in ESM\r\n// GUN = require('gun'); // in NodeJS\r\n// GUN = require('gun/gun'); // in React\r\ngun = GUN();\r\n\r\ngun.get('mark').put({\r\n  name: \"Mark\",\r\n  email: \"mark@gun.eco\",\r\n});\r\n\r\ngun.get('mark').on((data, key) =\u003e {\r\n  console.log(\"realtime updates:\", data);\r\n});\r\n\r\nsetInterval(() =\u003e { gun.get('mark').get('live').put(Math.random()) }, 9);\r\n\u003c/script\u003e\r\n```\r\n- Or try something **mind blowing**, like saving circular references to a table of documents! ([play](http://jsbin.com/wefozepume/edit?js,console))\r\n```javascript\r\ncat = {name: \"Fluffy\", species: \"kitty\"};\r\nmark = {boss: cat};\r\ncat.slave = mark;\r\n\r\n// partial updates merge with existing data!\r\ngun.get('mark').put(mark);\r\n\r\n// access the data as if it is a document.\r\ngun.get('mark').get('boss').get('name').once(function(data, key){\r\n  // `once` grabs the data once, no subscriptions.\r\n  console.log(\"Mark's boss is\", data);\r\n});\r\n\r\n// traverse a graph of circular references!\r\ngun.get('mark').get('boss').get('slave').once(function(data, key){\r\n  console.log(\"Mark is the cat's slave!\", data);\r\n});\r\n\r\n// add both of them to a table!\r\ngun.get('list').set(gun.get('mark').get('boss'));\r\ngun.get('list').set(gun.get('mark'));\r\n\r\n// grab each item once from the table, continuously:\r\ngun.get('list').map().once(function(data, key){\r\n  console.log(\"Item:\", data);\r\n});\r\n\r\n// live update the table!\r\ngun.get('list').set({type: \"cucumber\", goal: \"jumping cat\"});\r\n```\r\n\r\nWant to keep building more? **Jump to [THE DOCUMENTATION](#documentation)!**\r\n\r\n# About\r\nFirst \u0026 foremost, GUN is **a community of the nicest and most helpful people** out there. So [I want to invite you](http://chat.gun.eco) to come tell us about what **you** are working on \u0026 wanting to build (new or old school alike! Just be nice as well.) and ask us your questions directly. :)\r\n\r\n\u003cp align=\"center\"\u003e\u003ca href=\"https://www.youtube.com/watch?v=oTQXzhm8w_8\"\u003e\u003cimg width=\"250\" src=\"https://img.youtube.com/vi/oTQXzhm8w_8/0.jpg\"\u003e\u003cbr/\u003eWatch the 100 second intro!\u003c/a\u003e\u003c/p\u003e\r\n\r\nThe GUN ecosystem stack is a collection of independent and modular tools covering everything from [CRDT](https://crdt.tech/) [conflict resolution](https://gun.eco/distributed/matters.html), [cryptographic security](https://gun.eco/docs/Cartoon-Cryptography) \u0026 [encryption](https://gun.eco/docs/SEA), [radix storage serialization](https://gun.eco/docs/RAD), [mesh networking](https://gun.eco/docs/DAM) \u0026 [routing algorithms](https://gun.eco/docs/Routing), to distributed systems [correctness \u0026 load testing](https://github.com/gundb/panic-server), CPU scheduled [JSON parser](https://github.com/amark/gun/blob/master/lib/yson.js) to prevent UI lag, and more!\r\n\r\n\u003cdiv\u003e\u003cimg width=\"48%\" src=\"https://gun.eco/see/stack.png\"/\u003e\r\n\u003cimg width=\"48%\" align=\"right\" src=\"https://gun.eco/see/layers.png\"/\u003e\u003c/div\u003e\r\n\r\nOn that note, let's get some official shout outs covered first:\r\n\r\n### Support\r\n\r\n\u003cp align=\"center\"\u003e\r\nThanks to:\r\n\r\n\u003ctable\u003e\r\n\u003ctr\u003e\r\n\u003ctd vlign=\"center\"\u003e\u003ca href=\"https://mozilla.org/builders\"\u003e\u003cimg height=\"100\" src=\"https://user-images.githubusercontent.com/1423657/81992335-85346480-9643-11ea-8754-8275e98e06bc.png\"\u003e\u003c/a\u003e\u003c/td\u003e\r\n\u003ctd vlign=\"center\"\u003e\u003ca href=\"http://unstoppabledomains.com/\"\u003e\u003cimg src=\"https://gun.eco/img/unstoppable.png\"\u003e\u003c/a\u003e\u003c/td\u003e\r\n\u003ctd vlign=\"center\"\u003e\u003ca href=\"https://mask.io/\"\u003e\u003cimg src=\"https://dimensiondev.github.io/Mask-VI/assets/Logo/MB--Logo--CombH-Circle--Blue.svg\" width=\"250\"\u003e\u003c/a\u003e\u003c/td\u003e\r\n\u003c/tr\u003e\r\n\u003ctr\u003e\r\n\u003ctd vlign=\"center\"\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u003ca href=\"https://www.ajar.org/\"\u003e\u003cimg src=\"https://www.ajar.org/logo.png\" height=\"120\"\u003e\u003c/a\u003e\u003c/td\u003e\r\n\u003ctd vlign=\"center\"\u003e\u003ca href=\"https://wallie.io/\"\u003e\u003cimg src=\"https://raw.githubusercontent.com/gundb/gun-site/master/img/wallie.png\" width=\"250\"\u003e\u003c/a\u003e\u003c/td\u003e\r\n\u003ctd vlign=\"center\"\u003e\u0026nbsp;\u0026nbsp;\u003ca href=\"https://ghostdrive.com/\"\u003e\u003cimg src=\"https://gun.eco/img/ghostdrive.png\" height=\"120\"\u003e\u003c/a\u003e\u003c/td\u003e\r\n\u003c/tr\u003e\r\n\u003c/table\u003e\r\n\r\n\u003ca href=\"https://github.com/robertheessels\"\u003eRobert Heessels\u003c/a\u003e,\r\n\u003ca href=\"http://qxip.net/\"\u003eLorenzo Mangani\u003c/a\u003e,\r\n\u003ca href=\"https://nlnet.nl/\"\u003eNLnet Foundation\u003c/a\u003e,\r\n\u003ca href=\"http://github.com/samliu\"\u003eSam Liu\u003c/a\u003e,\r\n\u003ca href=\"http://github.com/ddombrow\"\u003eDaniel Dombrowsky\u003c/a\u003e,\r\n\u003ca href=\"http://github.com/vincentwoo\"\u003eVincent Woo\u003c/a\u003e,\r\n\u003ca href=\"http://github.com/coolaj86\"\u003eAJ ONeal\u003c/a\u003e,\r\n\u003ca href=\"http://github.com/ottman\"\u003eBill Ottman\u003c/a\u003e,\r\n\u003ca href=\"http://github.com/mikewlange\"\u003eMike Lange\u003c/a\u003e,\r\n\u003ca href=\"http://github.com/ctrlplusb\"\u003eSean Matheson\u003c/a\u003e,\r\n\u003ca href=\"http://github.com/alanmimms\"\u003eAlan Mimms\u003c/a\u003e,\r\n\u003ca href=\"https://github.com/dfreire\"\u003eDário Freire\u003c/a\u003e,\r\n\u003ca href=\"http://github.com/velua\"\u003eJohn Williamson\u003c/a\u003e,\r\n\u003ca href=\"http://github.com/finwo\"\u003eRobin Bron\u003c/a\u003e,\r\n\u003ca href=\"http://github.com/ElieMakhoul\"\u003eElie Makhoul\u003c/a\u003e,\r\n\u003ca href=\"http://github.com/mikestaub\"\u003eMike Staub\u003c/a\u003e,\r\n\u003ca href=\"http://github.com/bmatusiak\"\u003eBradley Matusiak\u003c/a\u003e,\r\n\u003ca href=\"https://github.com/sjuxax\"\u003eJeff Cook\u003c/a\u003e,\r\n\u003ca href=\"https://github.com/nmauersberg\"\u003eNico\u003c/a\u003e,\r\n\u003ca href=\"https://github.com/ajartille\"\u003eAaron Artille\u003c/a\u003e,\r\n\u003ca href=\"https://github.com/timjrobinson\"\u003eTim Robinson\u003c/a\u003e,\r\n\u003ca href=\"https://github.com/hibas123\"\u003eFabian Stamm\u003c/a\u003e,\r\n\u003ca href=\"https://twitter.com/mikestaub\"\u003eMike Staub\u003c/a\u003e,\r\n\u003ca href=\"https://hunterowens.com/\"\u003eHunter Owens\u003c/a\u003e,\r\n\u003ca href=\"https://github.com/JacobMillner\"\u003eJacob Millner\u003c/a\u003e,\r\n\u003ca href=\"https://github.com/b-lack\"\u003eGerrit Balindt\u003c/a\u003e,\r\n\u003ca href=\"https://github.com/gabriellemon\"\u003eGabriel Lemon\u003c/a\u003e,\r\n\u003ca href=\"https://github.com/murageyun\"\u003eMurage Martin\u003c/a\u003e,\r\n\u003ca href=\"https://github.com/octalmage\"\u003eJason Stallings\u003c/a\u003e\r\n\u003c/p\u003e\r\n\r\n - Join others in sponsoring code: https://www.patreon.com/gunDB !\r\n - Ask questions: http://stackoverflow.com/questions/tagged/gun ?\r\n - Found a bug? Report at: https://github.com/amark/gun/issues ;\r\n - **Need help**? Chat with us: http://chat.gun.eco .\r\n\r\n### History\r\n\r\n[GUN](https://gun.eco) was created by [Mark Nadal](https://twitter.com/marknadal) in 2014 after he had spent 4 years trying to get his collaborative web app to scale up with traditional databases.\r\n\r\n\u003cimg width=\"250px\" src=\"https://gun.eco/see/problem.png\" align=\"left\" title=\"pain point\" style=\"margin: 0 1em 1em 0\"\u003e After he realized [Master-Slave database architecture causes one big bottleneck](https://gun.eco/distributed/matters.html), he (as a complete newbie outsider) naively decided **to question the status quo** and shake things up with controversial, heretical, and contrarian experiments:\r\n\r\n**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).\r\n\r\nThe 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.\r\n\r\n\u003cimg src=\"https://gun.eco/see/compare.png\" title=\"comparison table\"\u003e\r\n\r\nTechnically, **GUN is a graph synchronization protocol** with a *lightweight embedded engine*, capable of doing *[20M+ API ops/sec](https://gun.eco/docs/Performance)* in **just ~9KB gzipped size**.\r\n\r\n## Documentation\r\n\r\n\u003ctable\u003e\r\n  \u003ctr\u003e\r\n    \u003ctd style=\"border: 0;\"\u003e\u003ch3\u003e\u003ca href=\"https://gun.eco/docs/API\"\u003eAPI reference\u003c/a\u003e\u003c/h3\u003e\u003c/td\u003e\r\n    \u003ctd style=\"border: 0;\"\u003e\u003ch3\u003e\u003ca href=\"https://gun.eco/docs/Todo-Dapp\"\u003eTutorials\u003c/a\u003e\u003c/h3\u003e\u003c/td\u003e\r\n    \u003ctd style=\"border: 0;\"\u003e\u003ch3\u003e\u003ca href=\"https://github.com/amark/gun/tree/master/examples\"\u003eExamples\u003c/a\u003e\u003c/h3\u003e\u003c/td\u003e\r\n  \u003c/tr\u003e\r\n  \u003ctr\u003e\r\n    \u003ctd style=\"border: 0;\"\u003e\u003ch3\u003e\u003ca href=\"https://github.com/brysgo/graphql-gun\"\u003eGraphQL\u003c/a\u003e\u003c/h3\u003e\u003c/td\u003e\r\n    \u003ctd style=\"border: 0;\"\u003e\u003ch3\u003e\u003ca href=\"https://github.com/PenguinMan98/electrontest\"\u003eElectron\u003c/a\u003e\u003c/h3\u003e\u003c/td\u003e\r\n    \u003ctd style=\"border: 0;\"\u003e\u003ch3\u003e\u003ca href=\"https://gun.eco/docs/React-Native\"\u003eReact \u0026 Native\u003c/a\u003e\u003c/h3\u003e\u003c/td\u003e\r\n  \u003c/tr\u003e\r\n  \u003ctr\u003e\r\n    \u003ctd style=\"border: 0;\"\u003e\u003ch3\u003e\u003ca href=\"https://github.com/sjones6/vue-gun\"\u003eVue\u003c/a\u003e\u003c/h3\u003e\u003c/td\u003e\r\n    \u003ctd style=\"border: 0;\"\u003e\u003ch3\u003e\u003ca href=\"https://gun.eco/docs/Svelte\"\u003eSvelte\u003c/a\u003e\u003c/h3\u003e\u003c/td\u003e\r\n    \u003ctd style=\"border: 0;\"\u003e\u003ch3\u003e\u003ca href=\"https://github.com/Stefdv/gun-ui-lcd#syncing\"\u003eWebcomponents\u003c/a\u003e\u003c/h3\u003e\u003c/td\u003e\r\n  \u003c/tr\u003e\r\n  \u003ctr\u003e\r\n    \u003ctd style=\"border: 0;\"\u003e\u003ch3\u003e\u003ca href=\"https://gun.eco/docs/CAP-Theorem\"\u003eCAP Theorem Tradeoffs\u003c/a\u003e\u003c/h3\u003e\u003c/td\u003e\r\n    \u003ctd style=\"border: 0;\"\u003e\u003ch3\u003e\u003ca href=\"https://gun.eco/distributed/matters.html\"\u003eHow Data Sync Works\u003c/a\u003e\u003c/h3\u003e\u003c/td\u003e\r\n    \u003ctd style=\"border: 0;\"\u003e\u003ch3\u003e\u003ca href=\"https://gun.eco/docs/Porting-GUN\"\u003eHow GUN is Built\u003c/a\u003e\u003c/h3\u003e\u003c/td\u003e\r\n  \u003c/tr\u003e\r\n  \u003ctr\u003e\r\n    \u003ctd style=\"border: 0;\"\u003e\u003ch3\u003e\u003ca href=\"https://gun.eco/docs/Auth\"\u003eCrypto Auth\u003c/a\u003e\u003c/h3\u003e\u003c/td\u003e\r\n    \u003ctd style=\"border: 0;\"\u003e\u003ch3\u003e\u003ca href=\"https://github.com/amark/gun/wiki/Awesome-GUN\"\u003eModules\u003c/a\u003e\u003c/h3\u003e\u003c/td\u003e\r\n    \u003ctd style=\"border: 0;\"\u003e\u003ch3\u003e\u003ca href=\"https://gun.eco/docs/Roadmap\"\u003eRoadmap\u003c/a\u003e\u003c/h3\u003e\u003c/td\u003e\r\n  \u003c/tr\u003e\r\n\u003c/table\u003e\r\n\r\nThis would not be possible without **community contributors**, big shout out to:\r\n\r\n**[ajmeyghani](https://github.com/ajmeyghani) ([Learn GUN Basics with Diagrams](https://medium.com/@ajmeyghani/gundb-a-graph-database-in-javascript-3860a08d873c))**; **[anywhichway](https://github.com/anywhichway) ([Block Storage](https://github.com/anywhichway/gun-block))**; **[beebase](https://github.com/beebase) ([Quasar](https://github.com/beebase/gun-vuex-quasar))**; **[BrockAtkinson](https://github.com/BrockAtkinson) ([brunch config](https://github.com/BrockAtkinson/brunch-gun))**; **[Brysgo](https://github.com/brysgo) ([GraphQL](https://github.com/brysgo/graphql-gun))**; **[d3x0r](https://github.com/d3x0r) ([SQLite](https://github.com/d3x0r/gun-db))**; **[forrestjt](https://github.com/forrestjt) ([file.js](https://github.com/amark/gun/blob/master/lib/file.js))**; **[hillct](https://github.com/hillct) (Docker)**; **[JosePedroDias](https://github.com/josepedrodias) ([graph visualizer](http://acor.sl.pt:9966))**; **[JuniperChicago](https://github.com/JuniperChicago) ([cycle.js bindings](https://github.com/JuniperChicago/cycle-gun))**; **[jveres](https://github.com/jveres) ([todoMVC](https://github.com/jveres/todomvc))**; **[kristianmandrup](https://github.com/kristianmandrup) ([edge](https://github.com/kristianmandrup/gun-edge))**; **[Lightnet](https://github.com/Lightnet)** ([Awesome Vue User Examples](https://glitch.com/edit/#!/jsvuegunui?path=README.md:1:0) \u0026 [User Kitchen Sink Playground](https://gdb-auth-vue-node.glitch.me/)); **[lmangani](https://github.com/lmangani) ([Cytoscape Visualizer](https://github.com/lmangani/gun-scape), [Cassandra](https://github.com/lmangani/gun-cassandra), [Fastify](https://github.com/lmangani/fastify-gundb), [LetsEncrypt](https://github.com/lmangani/polyGun-letsencrypt))**; **[mhelander](https://github.com/mhelander) ([SEA](https://github.com/amark/gun/blob/master/sea.js))**; [omarzion](https://github.com/omarzion) ([Sticky Note App](https://github.com/omarzion/stickies)); [PsychoLlama](https://github.com/PsychoLlama) ([LevelDB](https://github.com/PsychoLlama/gun-level)); **[RangerMauve](https://github.com/RangerMauve) ([schema](https://github.com/gundb/gun-schema))**; **[robertheessels](https://github.com/swifty) ([gun-p2p-auth](https://github.com/swifty/gun-p2p-auth))**; **[rogowski](https://github.com/rogowski) (AXE)**; [sbeleidy](https://github.com/sbeleidy); **[sbiaudet](https://github.com/sbiaudet) ([C# Port](https://github.com/sbiaudet/cs-gun))**; **[Sean Matheson](https://github.com/ctrlplusb) ([Observable/RxJS/Most.js bindings](https://github.com/ctrlplusb/gun-most))**; **[Shadyzpop](https://github.com/Shadyzpop) ([React Native example](https://github.com/amark/gun/tree/master/examples/react-native))**; **[sjones6](https://github.com/sjones6) ([Flint](https://github.com/sjones6/gun-flint))**; RIP **[Stefdv](https://github.com/stefdv) (Polymer/web components)**; **[zrrrzzt](https://github.com/zrrrzzt) ([JWT Auth](https://gist.github.com/zrrrzzt/6f88dc3cedee4ee18588236756d2cfce))**; **[xmonader](https://github.com/xmonader) ([Python Port](https://github.com/xmonader/pygundb))**; \r\n\r\nI am missing many others, apologies, will be adding them soon! This list is infinitely old \u0026 way out of date, if you want to be listed in it please make a PR! :)\r\n\r\n## Testing\r\n\r\nYou will need to `npm install -g mocha` first. Then in the gun root folder run `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 `rm -rf *data*` command in the project directory.\r\n\r\n## Shims\r\n\r\n \u003e These are only needed for NodeJS \u0026 React Native, they shim the native Browser WebCrypto API.\r\n\r\nIf you want to use [SEA](https://gun.eco/docs/SEA) for `User` auth and security, you will need to install:\r\n\r\n`npm install @peculiar/webcrypto --save`\r\n\r\nPlease see [our React Native docs](https://gun.eco/docs/React-Native) for installation instructions!\r\n\r\nThen you can require [SEA](https://gun.eco/docs/SEA) without an error:\r\n\r\n```javascript\r\nGUN = require('gun/gun');\r\nSEA = require('gun/sea');\r\n```\r\n\r\n## Deploy\r\n\r\n \u003e Note: The default examples that get auto-deployed on `npm start` CDN-ify all GUN files, modules, \u0026 storage.\r\n \r\n \u003e Note: Moving forward, AXE will start to automatically cluster your peer into a shared DHT. You may want to disable this to run an isolated network.\r\n \r\n \u003e Note: When deploying a web application using GUN on a cloud provider, you may have to set `CI=false` in your `.env`. This prevents GUN-specific warnings from being treated as errors when deploying your app. You may also resolve this by modifying your webpack config to not try to build the GUN dependencies.\r\n\r\nTo quickly spin up a GUN relay peer for your development team, utilize [Heroku](http://heroku.com), [Docker](http://docker.com), or any others listed below. Or some variant thereof [Dokku](http://dokku.viewdocs.io/dokku/), K8s, etc. ! Or use all of them so your relays are decentralized too!\r\n\r\n### Linux\r\n\r\n`SSH` into the home directory of a clean OS install with `sudo` ability. Set any environment variables you need (see below), then do:\r\n\r\n```bash\r\ncurl -o- https://raw.githubusercontent.com/amark/gun/master/examples/install.sh | bash\r\n```\r\n\r\n \u003e Read [install.sh](https://github.com/amark/gun/blob/master/examples/install.sh) first!\r\n \u003e If `curl` is not found, *copy\u0026paste* the contents of install.sh into your ssh.\r\n\r\nYou can now safely `CTRL+A+D` to escape without stopping the peer. To stop everything `killall screen` or `killall node`.\r\n\r\nEnvironment variables may need to be set like `export HTTPS_CERT=~/cert.pem HTTPS_KEY=~/key.pem PORT=443`. You can also look at a sample [nginx](https://gun.eco/docs/nginx) config. For production deployments, you probably will want to use something like `pm2` or better to keep the peer alive after machine reboots.\r\n\r\n### [Dome](https://www.trydome.io/)\r\n[Deploy GUN in one-click](https://app.trydome.io/signup?package=gun) with [Dome](https://trydome.io) and receive a free trial:\r\n\r\n[![Deploy to Dome](https://trydome.io/button.svg)](https://app.trydome.io/signup?package=gun)\r\n\r\n### [Heroku](https://www.heroku.com/)\r\n\r\n[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/amark/gun)\r\n\r\n \u003e Heroku deletes your data every 15 minutes, one way to fix this is by adding [cheap storage](https://gun.eco/docs/Using-Amazon-S3-for-Storage).\r\n\r\nOr:\r\n\r\n```bash\r\ngit clone https://github.com/amark/gun.git\r\ncd gun\r\nheroku create\r\ngit push -f heroku HEAD:master\r\n```\r\n\r\nThen visit the URL in the output of the 'heroku create' step, in a browser. Make sure to set any environment config vars in the settings tab.\r\n\r\n### [Zeet.co](https://www.zeet.co/)\r\n\r\n[![Deploy](https://deploy.zeet.co/gun.svg)](https://deploy.zeet.co/?url=https://github.com/amark/gun)\r\n\r\nThen visit the URL in the output of the 'now --npm' step, in your browser.\r\n\r\n### [Docker](https://www.docker.com/)\r\n\r\n \u003e Warning: Docker image is community contributed and may be old with missing security updates, please check version numbers to compare.\r\n\r\n[![Docker Automated build](https://img.shields.io/docker/automated/gundb/gun.svg)](https://hub.docker.com/r/gundb/gun/) [![](https://images.microbadger.com/badges/image/gundb/gun.svg)](https://microbadger.com/images/gundb/gun \"Get your own image badge on microbadger.com\") [![Docker Pulls](https://img.shields.io/docker/pulls/gundb/gun.svg)](https://hub.docker.com/r/gundb/gun/) [![Docker Stars](https://img.shields.io/docker/stars/gundb/gun.svg)](https://hub.docker.com/r/gundb/gun/)\r\n\r\nPull from the [Docker Hub](https://hub.docker.com/r/gundb/gun/) [![](https://images.microbadger.com/badges/commit/gundb/gun.svg)](https://microbadger.com/images/gundb/gun). Or:\r\n\r\n```bash\r\ndocker run -p 8765:8765 gundb/gun\r\n```\r\n\r\nOr build the [Docker](https://docs.docker.com/engine/installation/) image locally:\r\n\r\n```bash\r\ngit clone https://github.com/amark/gun.git\r\ncd gun\r\ndocker build -t myrepo/gundb:v1 .\r\ndocker run -p 8765:8765 myrepo/gundb:v1\r\n```\r\n\r\nOr, if you prefer your Docker image with metadata labels (Linux/Mac only):\r\n\r\n```bash\r\nnpm run docker\r\ndocker run -p 8765:8765 username/gun:git\r\n```\r\n\r\nThen visit [http://localhost:8765](http://localhost:8765) in your browser.\r\n\r\n## License\r\n\r\nDesigned with ♥ by Mark Nadal, the GUN team, and many amazing contributors.\r\n\r\nOpenly licensed under [Zlib / MIT / Apache 2.0](https://github.com/amark/gun/blob/master/LICENSE.md).\r\n\r\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Famark%2Fgun.svg?size=large)](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Famark%2Fgun?ref=badge_large)\r\n\r\n[YouTube](https://www.youtube.com/channel/UCQAtpf-zi9Pp4__2nToOM8g) . [Twitter](https://twitter.com/marknadal)\r\n","funding_links":["https://github.com/sponsors/amark","https://patreon.com/gunDB","https://opencollective.com/gun","https://www.patreon.com/gunDB"],"categories":["Protocols and Specifications","JavaScript","Software Development","replication","其他_安全与渗透","Databases","database","blockchain","Storage","High level","Cloud Platforms"],"sub_categories":["General","Database","网络服务_其他","Data","Security"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Famark%2Fgun","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Famark%2Fgun","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Famark%2Fgun/lists"}