https://github.com/fanboykun/vsg
https://github.com/fanboykun/vsg
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/fanboykun/vsg
- Owner: fanboykun
- Created: 2023-07-12T13:46:41.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-10T17:37:44.000Z (about 2 years ago)
- Last Synced: 2025-03-17T08:43:09.411Z (7 months ago)
- Language: Svelte
- Size: 81.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Svelte + Vite + Gun
VSG (app) Repo
Relay Server Repo
### Introduction
Decentralized chat application with Gun, built by Svelte and Vite.
This app provides real time, decentralized and secure chat app.
Where you own and control your own data without any worries.
### Pre Requisite
- Node.js version 18x
- npm or pnpm latest version
- Modern web browser (chrome, edge, firefox) latest version
- Terminal
### Instalation
This project uses pnpm as the package manager
so if you would like to use pnpm or npm
make sure to first delete the node_modules
directory if it exist.
- install all the dependencies :
```pnpm i```
or if you prefer npm :
```npm install```
### Development
#### Note: In order to make this app run properly, first run the relay server in other terminal before running this App.
- type this command :
```pnpm dev```
or if you prefer npm :
```npm run dev```
you should see the info in the terminal after you execute the command, follow the link and open another browser session to communicate between users.
### Applications Steps
After you open up at least 2 browser session
follow this step to use the app
- Login or Register
- Click Start Conversation
- Type the recepient's username
- Click Search
- And then click start
- Now you can chat with the recepient