sample-readme-1.md

Project Name

---

Requirements to Run the Project

• ReactJs
• MongoDB
• NodeJS

---

🚀 Instructions

1. Download Necessary Tools:

   • Make sure you have the latest versions of NodeJS, npm, and yarn installed.
   • Download the MongoDB terminal tools package.
   • Download and install MongoDB Community.

2. Download and Install Project Dependencies:

   • For the frontend:

     yarn install
     

   • For the backend:

     cd server
     yarn install
     

   • Start the backend to generate the database

     cd server/src
     node index.js
     

---

🛠️ Data Configuration

1. Create the .env File:

   • Create a .env file based on the template in .env-copy for both the backend and frontend.
   • Include the URLs for the backend API and MongoDB connection.

2. Import MongoDB Database:

   1. Go to the MongoDB executables directory.
   2. Move the .csv files from the "extra" folder to the MongoDB folder.
   3. Run the following commands to import the collections:
      • Restaurants:

        mongoimport /db:sabor-rapido /collection:restaurants /file:restaurantes.csv
        

      • Users:

        mongoimport /db:sabor-rapido /collection:users /file:users.csv
        

---

Running the Project

• For the frontend:

  yarn start
  

• For the backend:

  cd server/src
  node index.js
  

---

📖 Author

Ｍ♢ＮＴΛＳＩＭ