mercuryworkshop-mirror/adrift
1
0
Fork 0
mirror of https://github.com/MercuryWorkshop/adrift.git synced 2025-05-13 14:20:01 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

small tutorial in readme

Browse source
This commit is contained in:
ProgrammerIn-wonderland 2023-08-14 13:36:49 -04:00
parent 619e1c999b
commit 8e87fc1a9b
1 changed files with 48 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

48
README.md Normal file
View file

@ -0,0 +1,48 @@
# ADrift
ADrift is a Peer to Peer proxy utilizing the WebRTC protocol.
### Before everything..
install dependencies and build bare-client-custom
```
pnpm install
cd bare-client-custom
pnpm install
pnpm build
cd ..
```
### Getting started
Currently, there aren't any middle nodes, only an exit node which is requires nodejs to run.
### Getting started with the server
inside the server/ directory, run `pnpm install`, followed by `pnpm dev`
### Getting started with the client
Inside the frontend/ directory, run `pnpm install` and then `VITE_ADRIFT_DEV=1 VITE_ADRIFT_SINGLEFILE= pnpm dev`
### Quick server setup (linux)
```
git submodule update --init --recursive
pnpm install
cd bare-client-custom
pnpm install
pnpm build
cd ..
cd server/
pnpm install
pnpm dev
```
### Quick client setup (linux)
```
git submodule update --init --recursive
pnpm install
cd bare-client-custom
pnpm install
pnpm build
cd ..
cd frontend/
pnpm install
pnpm VITE_ADRIFT_DEV=1 VITE_ADRIFT_SINGLEFILE= pnpm dev
```