Project Name

previous project description

---

Index 📑

1. About project
   • Demo project
   • Technologies used in the project
2. How to use
   • Requirements
   • How to install

---

About

describe a summary of your project and what it does.

---

Demo Project

View demo

Technology used

• Frontend:

  • HTML
  • CSS
  • Javascript
  • Frameworks / Libraries:
    • React.js

• Backend:

  • Node.js
  • Frameworks:
    • Express.js
  • Libraries and Packages:
    • Nodemon
    • Body-parser
    • Cors
    • Browser-sync
    • Date-fns
    • Mongoose

• Database:

  • MongoDB

---

How to use

Requirements

Have Node.js installed on the machine.

How to install

1. Download or clone the Project-name repository

    git clone git@github.com:Henrique1818/name-repository.git

2. Open the project in your preferred editor

3. In your terminal, install the necessary packages:

    yarn

or

    npm install

4. Great! Now you can go to the name-project folder and start the server:

    cd name-project-backend

    yarn start

or

    npm start

---

    cd name-project-frontend

    yarn start

or

    npm start

5. Open your browser! The name-project will be available at http://localhost:3000/

---

Author

Henrique 👾

Github | Instagram ❤️