Home

Documentation moved

The GUN Documentation can be found here:

Latest GUN Documentation

Below you can find the old documentation as a reference.

---

Old documentation

API Reference

• Gun constructor
• gun.put
• gun.key
• gun.get
• gun.path
• gun.set
• gun.back
• gun.on
• gun.map
• gun.val
• gun.not

Chaining - reference table for chaining dependencies

You should read the crash course on GUN!

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.

Projects

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

Snippets

Snippets provide small examples of using gun and include micro-modules.

Getting Started

• Here's our guide to getting started with gun and understanding it's core concepts.
• Learn how to start a gun server, so your browsers can sync between themselves.
• Or just clone the gun starter app to see how it all fits together.
• Explore the power of graphs and how they can be used to represent useful data structures.
• If you haven't already done so, look at our README.
• Peruse the examples' source code.
• Check out our list of helpful API extensions.

Getting Assistance

Usage Questions

Use the gun tag on StackOverflow

Issues

Add an issue to our GitHub repo

Discussion

Say hello on our Gitter channel

Contributing

• ⭐ Star our repository!
• 📺 Follow us!
  • Twitter
  • Facebook
  • YouTube
  • Meetup (held monthly in Provo, Utah)
• 🔈 Show off your gun projects!
• Help us squish bugs
• 📐 Build some cool plugins

License

Designed with ♥ by Mark Nadal, the gun team, and many very awesome contributors. Liberally licensed under Zlib / MIT / Apache 2.0.

Changelog

Also see the current Release List and Tag List for quick access to relevant versions.

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