search

ourjapanlife / findadoc-server

The api / server for Find A Doc, Japan. Check out the board to see the latest effort https://github.com/orgs/ourjapanlife/projects/8
3 stars 1 forks source link

chore: update readMe to be more comprehensive #454

Closed NabbeunNabi closed 1 month ago

NabbeunNabi commented 1 month ago

No issue linked due to no view for backend

What changed

The readMe was a bit outdated and therefore I could see new people coming in trying to run the dummy data in the local database have trouble setting it up. I went through and updated the language that was there and added instructions for two parts of Java that need to be installed. I also commented out the husky command. There is no script for it. Whether there should be or not it would just be a stumbling block for people who do not know why they are getting the error or might now be familiar with how we are implementing husky and linting

Testing instructions

You can follow step by step to see if it makes sense to you

theyokohamalife commented 1 month ago

@Anissa3005 @NabbeunNabi I pushed a small commit to reintroduce Husky to the README. Could you both confirm that it works? If so, we can update the PR title and description.

theyokohamalife commented 1 month ago

@Anissa3005 You'll need to approve this since you requested changes.