d2-holy-grail icon indicating copy to clipboard operation
d2-holy-grail copied to clipboard

Update readme

Open Nasicus opened this issue 5 years ago • 4 comments

  • Check if dev setup is still correct
  • Update with newest features
  • Add other missing stuff (if any)
  • Remove deprecated stuff (if any)

Nasicus avatar Jul 09 '19 17:07 Nasicus

@mpherman let me know if you have anything to add here, since you recently read it I guess.

Nasicus avatar Jul 09 '19 17:07 Nasicus

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.

mpherman avatar Jul 09 '19 17:07 mpherman

Maybe throw something in there about starting a local mongo, maybe through docker?

jkupcho avatar Aug 09 '19 01:08 jkupcho

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.

Nasicus avatar Aug 09 '19 05:08 Nasicus