From 00f6ede5571f35bdd889dc0f68c0707f78c68cec Mon Sep 17 00:00:00 2001 From: Abel Luck Date: Fri, 2 Jun 2023 10:38:45 +0000 Subject: [PATCH] update readme --- README.md | 31 ++++++++++++++++++------------- 1 file changed, 18 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 6a41474..ea26582 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,28 @@ # Dev Setup -Gitpod/Codespaces note: Use at least 16GB RAM. +> NOTE: When using Gitpod/Codespaces, use at least 16GB RAM -``` -git clone ... -cd link-stack -cd docker/zammad -make build -cd ../../ -npm install -turbo build -turbo dev -``` +Local dev with docker-compose -Prepare env secrets +* Create `link-stack/.env` from Bitwarden `root .env for link-stack` +* Run local dev with docker-compose: + ``` + git clone ... + cd link-stack + make start-dev + ``` + +Or for local dev of a single app * Create `link-stack/apps/link/.env.local` from Bitwarden `.env.local for link-stack/apps/link` * Create `link-stack/apps/metamigo-frontend/.metamigo.local.json` from Bitwarden `.metamigo.local.json for link-stack/apps/metamigo/frontend` -* Create `link-stack/.env` from Bitwarden `root .env for link-stack` +* Build locally for development: + ``` + make build + npm install + turbo --concurrency 30 build + turbo --concurrency 30 dev + ``` # Notes