d2-holy-grail
d2-holy-grail copied to clipboard
Update readme
- Check if dev setup is still correct
- Update with newest features
- Add other missing stuff (if any)
- Remove deprecated stuff (if any)
@mpherman let me know if you have anything to add here, since you recently read it I guess.
It was all good on dev steps for the most part. The only thing I might discuss is using npm ci
instead of npm install
.
I used npm ci
as it didn't update any packages and installed exactly the versions from package-lock.json
When I used npm install
it updated many dependencies to newer versions which might not be desired if someone is trying to install the current version of the app? I'm not sure if that was correct usage, but it worked for me.
Maybe throw something in there about starting a local mongo, maybe through docker?
It's currently listed as a Prerequisite
An installed and running instance of Mongo DB
However I'm also fine by checking in a docker-compose file or something like that wit ha mongo instance and adding this as an alternative to the readme, so you don't have to install mongo on your computer.