open.source/manifold
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update web README

Browse Source
This commit is contained in:
Austin Chen 2022-04-02 12:12:33 -07:00 committed by GitHub
parent d18cc372f6
commit cb0f9d922f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
web/README.md
View File

@ -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?