Readme build steps #36
Description
Hey!
So, I know you're all under a lot of pressure etc. and probs didn't have time, but the instructions for how to run the app need to be a bit better. I haven't managed to run locally, although I could probably just about figure it out (but I'll use my time for writing issues instead...).
You really don't need to list the dev dependencies in the readme, because I can find all that out from the package.json.
However, you really should include some basic instructions on setting up a database. This isn't something I do very often anyway, so it would be really good to have a reminder.
What you really need to include is details of what to put in a .env file! Also what this should be called and where it should go etc.
Also good would be:
- how to start (I can see different commands in the package.json)
- how to run the tests
and I'd be interested to know what you're using babel for and whether I need to run this too?
Sorry, don't want to sound like i'm complaining :) But this is great practice. It's good to write readmes as you go, so that you don't forget stuff. And if you ever want to come back to this project in the future and figure out how it works, you'll be glad you wrote it!