diff --git a/README.md b/README.md new file mode 100644 index 0000000..40ed744 --- /dev/null +++ b/README.md @@ -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 +``` \ No newline at end of file