You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-3Lines changed: 6 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -116,7 +116,7 @@ Do not commit it to version control!
116
116
117
117
Depending on how you answered the setup questions, you can bring up the stack:
118
118
119
-
- natively: `yarn dev`
119
+
- natively: `yarn start`
120
120
- with Docker: `export UID; docker-compose up`
121
121
- 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
122
122
@@ -179,9 +179,9 @@ Here's some more things we'd like to demonstrate that we've not got around to ye
179
179
180
180
## Documentation links
181
181
182
-
### yarn dev
182
+
### `yarn start` (or `docker-compose up`)
183
183
184
-
The `yarn dev` command runs a number of tasks:
184
+
This main command runs a number of tasks:
185
185
186
186
- 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
187
187
- 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:
190
190
- 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
191
191
- runs the `jest` tests in watch mode, automatically re-running as the database or test files change
192
192
193
+
For `docker-compose up` it also runs the PostgreSQL server that the system
194
+
connects to.
195
+
193
196
### Cypress e2e tests
194
197
195
198
Thanks to Cypress.io for sponsoring this work, we've added e2e tests covering
0 commit comments