Requirements README project 3

readme-project-3.md

README Project 3

Create 2 Readme files (one for the Frontend + one for the Backend). In each of them, add the sections below:

• Description

  • Brief description of the project
  • IMPORTANT:
    • Explain very clear if the current repo is the Frontend (React) or the Backend (Express API).
    • Provide a link to the other repo (ex. "a repository with the backend code can be found here...").

• Instructions to run this app in my computer. Probably something like this:

  • git clone
  • how to install dependencies (npm install)
  • environment variables: explain that I'd need to create a .env file and add environment variables (remember to detail all the variables that I may need to create, if I need to create an account to get some credentials etc.)
  • how to run the application (ex. npm run dev)

• Demo

  • Link where users can see the final version of your project (Netlify)
  • You can also provide the link to adaptable/fly.io, so that anyone can test the API.

(Bonus) Provide documentation for your API endpoints

For the backend, you can also document the endpoints that your API implements.

• Note: this takes time and is not an essential requirement (make sure you focus on the code, keep this as a bonus).
• Example: https://github.com/Ironborn-Ironhack-March-2022/ironborn-project-management-server/blob/main/README.md