Write in READme

[chrimcha]

Summary:

• If possible, each team member contributes to readme file buy added in the details of the sections they worked on the most
• Each team member should edit this issue to add in checkboxes for planning out what to write in the readme file

List of readme tasks to do by team member:

Christina

• [x] How to create a User (login and logout)
• [ ] How to interact with the User profile page (profile image, edit and delete), and what you should see in it
• [x] Explain the Cherry Score system and where to view your score
• [ ] What are categories(? not sure if we need this in there or if I will write it)

Rebecca

• [ ] add part to write
• [ ] add part to write

Bird

• [x] "About this project" summary
• [x] How to set up Google Maps API key for local usage in the app

Austin

• [x] Data initializer and manually adding triggers to mySQL workbench
• [ ] add part to write

[Tinxte]

Here is some inspiration for READMEs: https://dev.to/mfts/how-to-write-a-perfect-readme-for-your-github-project-59f2 https://github.com/ZOUHAIRFGRA/100-Project-Ideas-for-Full-Stack-Developers https://github.com/trending?since=monthly&spoken_language_code=en

Looks like a common breakdown is something like:

• Summary/Tech Stack
• Features
• Getting Started/How to Use
• FAQ/Notes
• Contributors/Credits

[Tinxte]

Started adding things to README in Pull Request https://github.com/ALLHUBS-Jan-2024-Liftoff/Cherry-Systems/pull/89 . Added summary, tech stack, and Maps API setup instructions to README. Also added my own features in the Features section.

[Tinxte]

Some things we may want to include in the How to Use section:

• Running NPM install
• Programs needed
• Set up, if any, for mySQL database?
• How to spin up locally