Skip to content
/ gun-vue Public

Vue + Gun = reactive p2p crypto graph app toolkit. Vue 3 composables and components, a relay server, a demo app and more!

Notifications You must be signed in to change notification settings

DeFUCC/gun-vue

Repository files navigation

Gun-Vue: The Peer-to-Peer Web App Toolkit

@gun-vue logo

HomeGitHubnpmYouTubeContact

Gun-Vue empowers you to build Offline-First, Progressive Web Apps (PWA) that run in any modern browser and securely synchronize data Peer-to-Peer (P2P) in Realtime without centralized servers.

Gun-Vue brings together three powerful technologies:

  • Peer-To-Peer (P2P) powered by Gun
  • Cryptography powered by SEA
  • Web Apps powered by Vue

...and combines them into several modular packages that make development Fast, Easy, and Fun!

Packages

Gun-Vue: Demo App

GitHub (/app)npmDemo

Features P2P social posts, end-to-end encrypted chat, web-torrent filesharing, and more!


Gun-Vue: Components

GitHub (/components)npmDocs

Prebuilt Vue 3 UI components that let you integrate real-time, P2P functionality into your projects.


Gun-Vue: Composables

GitHub (/composables)npmDocsAPI

Reusable logic (Vue 3 Composition API) for managing reactive, P2P data flows independently of any specific UI components.


Gun-Vue: Relay

GitHub (/relay)npmDocs

A Simple Gun Relay Peer for connecting clients and optional persistent storage.

How to Build the Workspace

  1. Clone this monorepo.
  2. Install pnpm.
  3. Run pnpm i to install all workspace dependencies.
  4. From the root folder, use:
    • pnpm run dev
    • pnpm run docs
    • pnpm run app
      to start each corresponding dev server.
  5. Run pnpm run builds to build all packages in the _dist folder.
corepack enable
pnpm i
pnpm run builds
open ./_dist/index.html

How to Contribute

We welcome ideas, bug reports, and pull requests:

  1. Fork the repository and create a new branch.
  2. Make changes and test locally.
  3. Submit a pull request with a brief summary.

Thank you for improving Gun-Vue!