day-cohort-70 / rare-api-rare-bear-team-4

rare-api-rare-bear-team-4 created by GitHub Classroom
0 stars 0 forks source link

DEV: Write the Read me #91

Open Sydney-M-Sharp opened 3 months ago

Sydney-M-Sharp commented 3 months ago

Heres what we have so far:

Rare: The Publishing Platform for the Discerning Writer

Getting Started

  1. Install dependencies: npm install
  2. Run the code npm start
  3. With the server also running, check that the login, register, and logout functionality is in working.
  4. This template is using Bulma for styling. Take a little bit of time to familiarize yourself with the framework if you would like to continue using it.

we need to finish this too

Sydney-M-Sharp commented 3 months ago

Read me examples:

Pro: https://github.com/gthole/drink-stash/blob/develop/README.md

Sydney's: https://github.com/Sydney-M-Sharp/Sms-CS-Capstone/blob/main/README.md

Sydney-M-Sharp commented 3 months ago

Formatting for Read Me

https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax