📚 Team Name : YOUR_WORST_NIGHTMARE (SUST) 📚

🏆 2nd in Preliminary Round 2 (Score : 89/100), Top Finalist in Code Samurai Hackathon 2024**

---

🌱 Eco-Sync : Waste Management Website 🌱

---🚮 Revolutionizing Waste Management in Dhaka North City Corporation 🚮---

---

📚 Eco-Sync : Diagrams

• All Diagrams are available in the "Project Diagram Folder/Readme" : ( 👉 Click Here )

🅰️ Eco-Sync : API Documentation

• API Documentation Using Excel : ( 👉 Click Here )
• We Also Used Swagger.js for API Documentation : Run The Project and Visit the Following URL : http://localhost:3000/api-docs/

❄️ Eco-Sync : UI/UX Design

• UI/UX Design Using Figma : ( 👉 Click Here )

🔮 Eco-Sync : PPTX Presentation

• PPTX Presentation : ( 👉 Click Here )
• For better view, Use The Canva Link: ( 👉 Click Here )

🎥 Eco-Sync : Complete Video Overview & Presentation

• Video Overview & Final Presentation : ( 👉 Click Here )

---

🐚 Eco-Sync : Setup Instructions (Mannual)

• 🔖 Clone the repository :

git clone https://github.com/Sumonta056/cs24-p2-Your_Worst-Nighmare.git

• 🔖 Go to the project directory and run the following command

cd Backend

• 🔖 Install Require Package For Backend

npm install

• 🔖 Run The Backend Server
  • Database is hosted on Mongodb Cloud Database (Not Local Database ) :Internet Connection is Required

npm start

• 🔖 Open Another Terminal and Go to the project directory and run the following command

cd Frontend

• 🔖 Install Require Package For Frontend

npm install

• 🔖 Run the Frontend ReactJS Server

  npm run dev

• 🔖 To visit the Website, Open the Browser and go to the following URL

http://localhost:5173/

• 🔖 To visit the API Documentation (We Used Swagger.js), Open the Browser and go to the following URL

http://localhost:3000/api-docs/

---

🐚 Eco-Sync : Setup Instructions (Docker)

• 🔖 Open the Terminal and Go to the project directory and run the following command to build docker images

docker-compose up --build

• 🔖 To run the docker using docker-compose.yml you need to run the following command

docker-compose up

• 🔖 Stop Docker after you finish visiting the website

docker-compose down

• 🔖 Docker is running properly !

---

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.