Update web README
This commit is contained in:
parent
d18cc372f6
commit
cb0f9d922f
|
@ -2,17 +2,18 @@
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
1. Run `npm install`
|
1. `yarn` to install all dependencies
|
||||||
2. Run `npm run dev`
|
2. `yarn dev:dev` to bring up a local instance, pointing to dev database)
|
||||||
3. Your site will be available on http://localhost:3000
|
3. Your site will be available on http://localhost:3000
|
||||||
|
|
||||||
|
(`yarn dev` will point you to prod database)
|
||||||
|
|
||||||
## Formatting
|
## 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
|
Recommended: Use a [Prettier editor integration](https://prettier.io/docs/en/editors.html) to automatically format on save
|
||||||
|
|
||||||
## Developer Experience TODOs
|
## Developer Experience TODOs
|
||||||
|
|
||||||
- Automatically run prettier as code commit hook?
|
|
||||||
- Prevent git pushing if there are Typescript errors?
|
- Prevent git pushing if there are Typescript errors?
|
||||||
|
|
Loading…
Reference in New Issue
Block a user