Skip to content

Commit a562fa1

Browse files
committed
Update README
1 parent 1987263 commit a562fa1

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ Do not commit it to version control!
116116

117117
Depending on how you answered the setup questions, you can bring up the stack:
118118

119-
- natively: `yarn dev`
119+
- natively: `yarn start`
120120
- with Docker: `export UID; docker-compose up`
121121
- NOTE: the `export UID` is really important on Linux otherwise the folders will end up owned by root and everything will suck. We recommend adding `export UID` to your `~/.profile` or `~/.bashrc` or similar
122122

@@ -179,9 +179,9 @@ Here's some more things we'd like to demonstrate that we've not got around to ye
179179

180180
## Documentation links
181181

182-
### yarn dev
182+
### `yarn start` (or `docker-compose up`)
183183

184-
The `yarn dev` command runs a number of tasks:
184+
This main command runs a number of tasks:
185185

186186
- uses [`graphile-migrate`](https://github.com/graphile/migrate) to watch the`migrations/current.sql` file for changes, and automatically runs it against your database when it changes
187187
- watches the TypeScript source code of the server, and compiles it from `@app/*/src` to `@app/*/dist` so node/`graphile-worker`/etc can run the compiled code directly
@@ -190,6 +190,9 @@ The `yarn dev` command runs a number of tasks:
190190
- watches your GraphQL files and your PostGraphile schema for changes and generates your TypeScript React hooks for you automatically, leading to strongly typed code with minimal effort
191191
- runs the `jest` tests in watch mode, automatically re-running as the database or test files change
192192

193+
For `docker-compose up` it also runs the PostgreSQL server that the system
194+
connects to.
195+
193196
### Cypress e2e tests
194197

195198
Thanks to Cypress.io for sponsoring this work, we've added e2e tests covering

0 commit comments

Comments
 (0)