diff --git a/web/README.md b/web/README.md index e16f0e9c..f9660eec 100644 --- a/web/README.md +++ b/web/README.md @@ -2,17 +2,18 @@ ## Getting Started -1. Run `npm install` -2. Run `npm run dev` +1. `yarn` to install all dependencies +2. `yarn dev:dev` to bring up a local instance, pointing to dev database) 3. Your site will be available on http://localhost:3000 +(`yarn dev` will point you to prod database) + ## Formatting -Before committing, run `npm run format` to format your code. +Before committing, run `yarn format` to format your code. Recommended: Use a [Prettier editor integration](https://prettier.io/docs/en/editors.html) to automatically format on save ## Developer Experience TODOs -- Automatically run prettier as code commit hook? - Prevent git pushing if there are Typescript errors?