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

Make instructions for setting up local instance of project clearer #49

Open
bl-aire opened this issue Jan 3, 2023 · 2 comments
Open
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@bl-aire
Copy link
Collaborator

bl-aire commented Jan 3, 2023

While trying to set up the project locally, I had some problems so I am suggesting these improvements to make the documentation better.

  • The third instruction says to "install mariadb" but it is already listed in the package.json file as a dependency and will be installed with other packages when npm i is run. I think the repetition can get contributors confused.
  • On running npm run dev I got an error because I did not have nodemon installed. Stating that nodemon is a requirement for setting up the project and clearly stating how it can be installed (npm install -g nodemon) can fix this.

This is open to a review by a maintainer and if the proposed changes are approved, I would love to be assigned to this issue:

@bl-aire bl-aire added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jan 3, 2023
@drewlearns
Copy link
Owner

I love it, feel free to update the readme

@bl-aire
Copy link
Collaborator Author

bl-aire commented Jan 6, 2023

I love it, feel free to update the readme

Thank you! I worked on it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants