From 92ed389d79ceda3a297a20f7365bcfe5dbe44001 Mon Sep 17 00:00:00 2001 From: Bobbie Soedirgo Date: Thu, 30 Jun 2022 16:36:54 +0800 Subject: [PATCH] chore(docs): update dev instructions --- web/README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/web/README.md b/web/README.md index d2f4805382e..0df143b8749 100644 --- a/web/README.md +++ b/web/README.md @@ -2,13 +2,12 @@ ### Contributing to the specs -- `cd /web/spec/` +- `cd ./web/spec/` - run `npm install` - run `make` which will pull the latest TSDoc with your updates > Note: `make` requires [`jq - a lightweight and flexible command-line JSON processor`](https://stedolan.github.io/jq/). To install on OSX with homebrew, run: `brew install jq`. -- Add your comments to `supabase.yml` | `dart.yml` | `postgrest.yml` | `gotrue.yml` | `realtime.yml` -- run `npm run gen:supabase` inside the `/spec` folder which will generate the Docusaurus pages -- run `npm run build` to make sure the build is working +- Apply your updates to `supabase.yml` | `dart.yml` | `postgrest.yml` | `gotrue.yml` | `realtime.yml` +- run `npm run build && npm run start` to make sure the build is working - Submit your PR