Skip to content
This repository has been archived by the owner on Jun 9, 2023. It is now read-only.

docs: mention seeding in Development Setup #401

Merged
merged 1 commit into from
Sep 13, 2020
Merged

docs: mention seeding in Development Setup #401

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,8 @@ The server will automatically restart anytime you save a `.ts` or `.js` file wit

You can run any command within the container by prefixing it with `docker-compose exec app`, e.g. `docker-compose exec app npm install express`

Next, [seed the DB](#seeding-the-db).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was this step also intentionally omitted from the "Natively running" section?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, the seeding section is immediately after that, so I figured people would naturally go to that after npm run dev. Do you think it would be better to repeat it?


#### Natively running node in Windows/MacOS/Linux (no docker)

DISCLAIMER: This is a more hands on approach.
Expand All @@ -115,7 +117,11 @@ MAKE SURE TO SET `IS_DOCKER=` in `.env` to blank
npm run dev
```

## Additional DB docs can be found in server/docs/README.md
## Seeding the DB

Initially the DB will be empty. To seed it with sample data, run `yarn db:reset`.

Additional DB docs can be found in [the contributing readme](CONTRIBUTING.md#database).

## Testing
Run tests
Expand Down