From cc88fa676329cbd2c4640b0f687fd490a46a6c95 Mon Sep 17 00:00:00 2001 From: cupcakearmy Date: Tue, 12 Apr 2022 09:12:40 +0200 Subject: [PATCH] readme --- README.md | 29 +++++++++++++++++++++++++---- 1 file changed, 25 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 38e2a38..dc4d9bf 100644 --- a/README.md +++ b/README.md @@ -127,11 +127,32 @@ services: ## Development -1. Clone -2. run `pnpm i` in the root and and client `client/` folders. -3. Run `pnpm run dev` to start development. +**Requirements** -Running `npm run dev` in the root folder will start the following things +- `pnpm`: `>=6` +- `node`: `>=14` +- `rust`: edition `2021` + +**Install** + +```bash +pnpm install +pnpm --prefix frontend install + +# Also you need cargo watch if you don't already have it installed. +# https://lib.rs/crates/cargo-watch +cargo install cargo-watch +``` + +**Run** + +Make sure you have docker running. + +```bash +pnpm run dev +``` + +Running `pnpm run dev` in the root folder will start the following things: - a memcache docker container - rust backend with hot reload