sderacy / gooncard

The Goon Squad's Goon Card Project for CSC 355 ('22)
http://gooncard.hpc.tcnj.edu:3000/
MIT License
6 stars 2 forks source link

Readme Update/Restructuring #82

Closed thadakn1 closed 2 years ago

thadakn1 commented 2 years ago

-i'm going to update the readme, but i just wanted everyone's input on what they think I should include on it (apart from what is already there)

let me know what you think @paytonshaltis @lelekaz @sderacy @matyis1

sderacy commented 2 years ago
  1. I think the instructions are a little confusing right now, like technically you don't need to run npm run cleanStart to seed the database but it says it should. We should probably combine setting up the DB and starting the server into one section instead of 2 sections in 2 different places.
  2. Accessibility concerns would be a good topic to cover
  3. The routes have changed.
  4. It would be good to explain the potential use cases for the application (how you use it, etc.)
sderacy commented 2 years ago

I think it'd be hard to articulate everything that I'd like to add / change so that's why I think it'd just be better to go in and do it myself once you have the branch up

Then it'll be much easier for others to add and remove stuff since this PR won't be linked to any other code functionalities :)

thadakn1 commented 2 years ago

Awesome! i'll just create the branch and add the points you listed above and everyone else can add to that branch whenever they feel :)