Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme #36

Open
Nasicus opened this issue Jul 9, 2019 · 4 comments
Open

Update readme #36

Nasicus opened this issue Jul 9, 2019 · 4 comments

Comments

@Nasicus
Copy link
Owner

Nasicus commented Jul 9, 2019

  • Check if dev setup is still correct
  • Update with newest features
  • Add other missing stuff (if any)
  • Remove deprecated stuff (if any)
@Nasicus
Copy link
Owner Author

Nasicus commented Jul 9, 2019

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

@mpherman
Copy link
Collaborator

mpherman commented Jul 9, 2019

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.

@jkupcho
Copy link
Contributor

jkupcho commented Aug 9, 2019

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

@Nasicus
Copy link
Owner Author

Nasicus commented Aug 9, 2019

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants