atordvairn / gun-vue Goto Github PK

Gun-vue – is where the peer-to-peer javascript database Gun meets the reactivity system of Vue 3. Pluggable components for UX designers. Easily importable composables for UI developers. Relay peer for p2p network enthusiasts. Demos and docs for beginners. Open source for everyone! ✊

@gun-vue is a collection of essential building blocks to create a variety of decentralized apps for online and offline collaboration. It's a moment when we can feel the nature of distributed networking and have fun together!

Gun is a CRDT distributed graph database, Vue is a reactive JS UI framework, SEA is web-browser cryptography adapter and together they evolve into an ecosystem of multiple app levels.

The project is committed to give all the basic tools for everyone to participate in exploring this new universe. You can find your own way in it for yourself.

There are 3 packages in the @gun-vue npmjs org for you to install and use:

Ready to use Vue 3 components as building blocks to implement Gun powered interactivity in seconds

Composable functions for use with Vue 3 Composition API

A simple no-store Gun server to throw at any free tier Node.js environment.

The main gun-vue.js.org site is an example Vite SPA

The docs at gun-vue.js.org/docs is an example Vitepress SSR web-site using @gun-vue/components

We manage tasks for the build at this Taskade project.

1. Clone the repo
2. Use pnpm to install all the dependencies in the workspaces

npm i -G pnpm
pnpm i

3. Use demo and docs scripts in the root package.json to run corresponding dev servers.
4. Use npm run build to build the whole project to the _dist folder.