{"repo":"amark/gun","free":true,"listed":false,"github":"https://github.com/amark/gun","clone":"git clone https://github.com/amark/gun.git","description":"An open source cybersecurity protocol for syncing decentralized graph data.","language":"JavaScript","stars":19113,"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"],"license":null,"category":"decentralized_backend","readme_excerpt":"

\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, & 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\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
\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 && npm start` (**5min** ~ average developer).\r\n\r\n> **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> 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\r\n\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 & 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 & wanting to build (new or old school alike! Just be nice as well.) and ask us your questions directly. :)\r\n\r\n


Watch the 100 second intro!

\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) & [encryption](https://gun.eco/docs/SEA), [radix storage serialization](https://gun.eco/docs/RAD), [mesh networking](https://gun.eco/docs/DAM) & [routing algorithms](https://gun.eco/docs/Routing), to distributed systems [correctness & 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
\r\n
\r\n\r\nOn that note, let's get some official shout outs covered first:\r\n\r\n### Support\r\n\r\n

\r\nThanks to:\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
             
\r\n\r\nRobert Heessels,\r\nLorenzo Mangani,\r\nNLnet Foundation,\r\nSam Liu,\r\nDaniel Dombrowsky,\r\nVincent Woo,\r\nAJ ONeal,\r\nBill Ottman,\r\nMike Lange,\r\nSean Matheson,\r\nAlan Mimms,\r\nDário Freire,\r\nJohn Williamson,\r\nRobin Bron,\r\nElie Makhoul,\r\nMike Staub,\r\nBradley Matusiak,\r\nJeff Cook,\r\nNico,\r\nAaron Artille,\r\nTim Robinson,\r\nFabian Stamm,\r\nMike Staub,\r\nHunter Owens,\r\nJacob Millner,\r\nGerrit Balindt,\r\nGabriel Lemon,\r\nMurage Martin,\r\nJason Stallings\r\n

\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 colla","default_branch":"master","files":597,"tree":[".dockerignore",".github/FUNDING.yml",".github/workflows/ci.yml",".gitignore",".npmignore",".prettierignore",".travis.yml","CHANGELOG.md","Dockerfile","LICENSE.md","Procfile","README.md","RELEASE.md","SECURITY.md","app.json","as.js","axe.js","bower.json","browser.js","examples/.gitignore","examples/Main.js","examples/angular/.angular-cli.json","examples/angular/.editorconfig","examples/angular/.gitignore","examples/angular/README.md","examples/angular/e2e/app.e2e-spec.ts","examples/angular/e2e/app.po.ts","examples/angular/e2e/tsconfig.e2e.json","examples/angular/example_package.json","examples/angular/karma.conf.js","examples/angular/protractor.conf.js","examples/angular/server.js","examples/angular/src/app/app.component.css","examples/angular/src/app/app.component.html","examples/angular/src/app/app.component.spec.ts","examples/angular/src/app/app.component.ts","examples/angular/src/app/app.module.ts","examples/angular/src/app/gun.helper.ts","examples/angular/src/app/gun.service.ts","examples/angular/src/assets/.gitkeep","examples/angular/src/environments/environment.prod.ts","examples/angular/src/environments/environment.ts","examples/angular/src/favicon.ico","examples/angular/src/index.html","examples/angular/src/main.ts","examples/angular/src/polyfills.ts","examples/angular/src/styles.css","examples/angular/src/test.ts","examples/angular/src/tsconfig.app.json","examples/angular/src/tsconfig.spec.json","examples/angular/src/typings.d.ts","examples/angular/tsconfig.json","examples/angular/tslint.json","examples/axe.html","examples/basic/chat.html","examples/basic/emoji.html","examples/basic/meet.html","examples/basic/note.html","examples/basic/paste.html","examples/basic/poll.html","examples/basic/post.html","examples/basic/private.html","examples/basic/schedule.html","examples/basic/screen.html","examples/basic/stream.html","examples/basic/tables.html","examples/basic/upload.html","examples/basic/user.html","examples/basic/video.html","examples/chat/index.html","examples/chat/user.html","examples/contact/index.html","examples/docs.html","examples/express.js","examples/game/furball.html","examples/game/nts.html","examples/game/space.html","examples/game/win.html","examples/hapi.js","examples/http.js","examples/https.sh","examples/index.html","examples/infinite-scroll/ScrollWindow.js","examples/infinite-scroll/index.html","examples/infinite-scroll/index.js","examples/infinite-scroll/style.css","examples/install.sh","examples/iris","examples/jquery.js","examples/json/index.html","examples/move/index.html","examples/party.html","examples/pop.png","examples/react-native/.babelrc","examples/react-native/.buckconfig","examples/react-native/.flowconfig","examples/react-native/.gitattributes","examples/react-native/.gitignore","examples/react-native/.watchmanconfig","examples/react-native/README.md","examples/react-native/android/app/BUCK","examples/react-native/android/app/build.gradle","examples/react-native/android/app/proguard-rules.pro","examples/react-native/android/app/src/main/AndroidManifest.xml","examples/react-native/android/app/src/main/assets/html/blank.html","examples/react-native/android/app/src/main/java/com/gundemo/MainActivity.java","examples/react-native/android/app/src/main/java/com/gundemo/MainApplication.java","examples/react-native/android/app/src/main/res/mipmap-hdpi/ic_launcher.png","examples/react-native/android/app/src/main/res/mipmap-hdpi/ic_launcher_round.png","examples/react-native/android/app/src/main/res/mipmap-mdpi/ic_launcher.png","examples/react-native/android/app/src/main/res/mipmap-mdpi/ic_launcher_round.png","examples/react-native/android/app/src/main/res/mipmap-xhdpi/ic_launcher.png","examples/react-native/android/app/src/main/res/mipmap-xhdpi/ic_launcher_round.png","examples/react-native/android/app/src/main/res/mipmap-xxhdpi/ic_launcher.png","examples/react-native/android/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png","examples/react-native/android/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png","examples/react-native/android/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png","examples/react-native/android/app/src/main/res/values/strings.xml","examples/react-native/android/app/src/main/res/values/styles.xml","examples/react-native/android/build.gradle","examples/react-native/android/gradle.properties","examples/react-native/android/gradle/wrapper/gradle-wrapper.jar","examples/react-native/android/gradle/wrapper/gradle-wrapper.properties","examples/react-native/android/gradlew","examples/react-native/android/gradlew.bat","examples/react-native/android/keystores/BUCK","examples/react-native/android/keystores/debug.keystore.properties","examples/react-native/android/settings.gradle","examples/react-native/app.json","examples/react-native/index.js","examples/react-native/ios/GunDemo-tvOS/Info.plist","examples/react-native/ios/GunDemo-tvOSTests/Info.plist","examples/react-native/ios/GunDemo.xcodeproj/project.pbxproj","examples/react-native/ios/GunDemo/AppDelegate.h","examples/react-native/ios/GunDemo/AppDelegate.m","examples/react-native/ios/GunDemo/Base.lproj/LaunchScreen.xib","examples/react-native/ios/GunDemo/Images.xcassets/AppIcon.appiconset/Contents.json","examples/react-native/ios/GunDemo/Images.xcassets/Contents.json","examples/react-native/ios/GunDemo/Info.plist","examples/react-native/ios/GunDemo/main.m","examples/react-native/ios/GunDemoTests/GunDemoTests.m","examples/react-native/ios/GunDemoTests/Info.plist","examples/react-native/package.json","examples/react-native/shim.js","examples/react-native/src/App/Demo.js","examples/react-native/src/App/PolyFillCrypto.js","examples/react-native/src/App/app.js","examples/react-native/src/App/index.js","examples/react-native/src/extensions/asyncStorageAdapter.js","examples/react-native/src/extensions/sea.js","examples/react-native/src/webview-crypto/MainWorker.d.ts","examples/react-native/src/webview-crypto/MainWorker.js","examples/react-native/src/webview-crypto/MainWorker.js.map","examples/react-native/src/webview-crypto/WebViewWorker.d.ts","examples/react-native/src/webview-crypto/WebViewWorker.js","examples/react-native/src/webview-crypto/WebViewWorker.js.map","examples/react-native/src/webview-crypto/asyncSerialize.d.ts","examples/react-native/src/webview-crypto/asyncSerialize.js","examples/react-native/src/webview-crypto/asyncSerialize.js.map","examples/react-native/src/webview-crypto/compat.d.ts","examples/react-native/src/webview-crypto/compat.js","examples/react-native/src/webview-crypto/compat.js.map","examples/react-native/src/webview-crypto/index.d.ts","examples/react-native/src/webview-crypto/index.js","examples/react-native/src/webview-crypto/index.js.map","examples/react-native/src/webview-crypto/serializeBinary.d.ts","examples/react-native/src/webview-crypto/serializeBinary.js","examples/react-native/src/webview-crypto/serializeBinary.js.map","examples/react-native/src/webview-crypto/webViewWorkerString.d.ts","examples/react-native/src/webview-crypto/webViewWorkerString.js","examples/react-native/src/webview-crypto/webViewWorkerString.js.map","examples/react/README.md","examples/react/public/favicon.ico","examples/react/public/index.html","examples/react/src/App.js","examples/react/src/App.test.js","examples/react/src/Chat.js","examples/react/src/Json.js","examples/react/src/Todos.js","examples/react/src/index.css","examples/react/src/index.js","examples/react/src/style.css","examples/react/todo.html","examples/relay-sqlite-example/README.md","examples/relay-sqlite-example/capacitor.config.ts","examples/relay-sqlite-example/index.html","examples/relay-sqlite-example/package.json","examples/relay-sqlite-example/src/App.vue","examples/relay-sqlite-example/src/components/RelayMode.vue","examples/relay-sqlite-example/src/composables/GunStorageAdapter.ts","examples/relay-sqlite-example/src/composables/useNetwork.ts","examples/relay-sqlite-example/src/composables/useNetworkStatus.ts","examples/relay-sqlite-example/src/composables/useToast.ts","examples/relay-sqlite-example/src/main.ts","examples/relay-sqlite-example/src/pages/index.vue","examples/relay-sqlite-example/src/router/index.ts","examples/relay-sqlite-example/src/services/dbVersionService.ts","examples/relay-sqlite-example/src/services/globalServices.ts","examples/relay-sqlite-example/src/services/initializeAppService.ts","examples/relay-sqlite-example/src/services/sqliteService.ts","examples/relay-sqlite-example/src/services/storageService.ts","examples/relay-sqlite-example/src/theme/variables.css","examples/relay-sqlite-example/tsconfig.json","examples/relay-sqlite-example/tsconfig.node.json","examples/relay-sqlite-example/vite.config.ts","examples/relay.service","examples/smoothie.js","examples/start.js.html","examples/stats.html","examples/style.css","examples/todo/index.html","examples/vanilla/screen.html","examples/vanilla/todo.html","examples/vanilla/user.html","examples/vanilla/video.html","examples/vue/index.html","examples/vue/todo.html","examples/wave.html","examples/webpack/.gitignore","examples/webpack/package.json","examples/webpack/src/app.js","examples/webpack/src/index.html","examples/webpack/webpack.config.js","examples/where/index.html","gun.d.ts","gun.js","gun.min.js","hooks/build","hooks/post_push","index.d.ts","index.js","kit/web.css","kit/web.js","lib/afore.js","lib/aws.js","lib/axe.js","lib/book.js","lib/bye.js","lib/crashed.js","lib/cryptomodules.js","lib/debug.js","lib/dom.js","lib/email.js","lib/erase.js","lib/evict.js","lib/file.js","lib/forget.js","lib/fork.js","lib/fsrm.js","lib/fun.js","lib/hot.js","lib/http.js","lib/hub.js","lib/ipfs.js","lib/ison.js","lib/jsonp.js","lib/later.d.ts","lib/later.js","lib/les.js","lib/level.js","lib/lex.js","lib/list.js","lib/load.d.ts","lib/load.js","lib/match.js","lib/memdisk.js","lib/meta.js","lib/mix.js","lib/mobile.js","lib/monotype.js","lib/multicast.js","lib/nomem.js","lib/normalize.js","lib/not.d.ts","lib/not.js","lib/open.d.ts","lib/open.js","lib/path.d.ts","lib/path.js","lib/promise.d.ts","lib/promise.js","lib/radisk.d.ts","lib/radisk.js","lib/radisk2.js","lib/radix.d.ts","lib/radix.js","lib/radix2.js","lib/radmigtmp.js","lib/ras.js","lib/reboot.js","lib/rfs.js","lib/rfsmix.js","lib/rindexed.d.ts","lib/rindexed.js","lib/rls.js","lib/rmem.js","lib/role.js","lib/rs3.js","lib/serve.js","lib/server.js","lib/service.js","lib/shim.js","lib/space.js","lib/stats.js","lib/store.d.ts","lib/store.js","lib/super.js","lib/text-encoding/LICENSE.md","lib/text-encoding/README.md","lib/text-encoding/index.js","lib/text-encoding/lib/encoding-indexes.js","lib/text-encoding/lib/encoding.js","lib/text-encoding/package.json","lib/then.d.ts","lib/then.js","lib/time.js","lib/unbuild.js","lib/unset.d.ts","lib/unset.js","lib/untitled.js","lib/upload.js","lib/utils.js","lib/uws.js","lib/verify.js","lib/wave.js","lib/webrtc.d.ts","lib/webrtc.js","lib/wire.js","lib/ws.js","lib/wsp.js","lib/wsproto.js","lib/yson.js","nts.js","package-lock.json","package.json","rad.js","sea.d.ts","sea.js","sea/aeskey.js","sea/array.js","sea/auth.js","sea/base64.js","sea/buffer.js","sea/certify.js","sea/create.js","sea/decrypt.js","sea/encrypt.js","sea/https.js","sea/index.js","sea/pair.js","sea/recall.js","sea/root.js","sea/sea.js","sea/secret.js","sea/settings.js","sea/sha1.js","sea/sha256.js","sea/share.js","sea/shim.js","sea/sign.js","sea/then.js","sea/user.js","sea/verify.js","sea/work.js","src/ask.js","src/back.js","src/book.js","src/chain.js","src/core.js","src/dup.js","src/get.js","src/index.js","src/localStorage.js","src/map.js","src/mesh.js","src/on.js","src/onto.js","src/polyfill/unbuild.js","src/put.js","src/root.js","src/set.js","src/shim.js","src/state.js","src/valid.js","src/websocket.js","test/abc.js","test/bug/121.js","test/bug/1243.js","test/bug/322.js","test/bug/686.js","test/bug/783.js","test/common.js","test/debug/deep-set.html","test/download-log.html","test/expect.js","test/gun.html","test/https/ca.crt","test/https/ca.csr","test/https/ca.key","test/https/server.crt"],"storefront":"/r/amark","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/amark/gun/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}