docs: mention seeding in Development Setup #401
Conversation
| @@ -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). | |||
There was a problem hiding this comment.
Was this step also intentionally omitted from the "Natively running" section?
There was a problem hiding this comment.
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?
|
Thanks @ojeytonwilliams We're still planning to move the technical docs in the CONTRIBUTING.md, but feel free to commit any changes to README for now. We've had a number of Windows 10 users with Docker issues, but nobody able to document their steps to fix it so far. Once the Docker info is updated I'd like to finish #360 by moving the majority of the technical info to CONTRIBUTING.md |
|
We're also looking for #396 to be merged in and we'll get all this technical info in one place. Quincy suggested CONTRIBUTING.md as a single technical doc instead of having things spread out all over the place. The README would become more of an overview of the purpose of the project, with links to the CONTRIBUTING.md |
|
Sounds good. I don't have much to say about Docker except that it works perfectly on Ubuntu and that I'm not surprised there are issues on Windows 10 - it's always a pain. |
|
@all-contributors add @ojeytonwilliams for infra and docs |
|
I've put up a pull request to add @ojeytonwilliams! 🎉 |
Update README.md).masterbranch of Chapter.It seemed worthwhile to put this in the initial setup guide, rather than leaving it to the detailed DB docs. I suspect most contributors will want to be working with a seeded DB, if only to cut out a little noise from the logs.