tiago-web / Ecoleta

♻ Connects drop-off locations to citizens. Web client and Rest API. Built using ReactJS, NodeJS and SQLite

Ecoleta ♻

Find the Nearest Drop-Off Locations

---

---

📌 Table of Contents

• Features
• Installation
• Getting Started
• Dependencies
• FAQ
• Found a bug? Missing a specific feature?
• License

🔗Features

• 📝 Register new drop-off locations.
• 🔍 Search for the nearest drop-off location.
• 💻 Connect recycling locations to citizens.

👷 Installation

You need to install Node.js. In order to clone the project via HTTPS, run this command:

git clone https://github.com/tiago-web/Ecoleta.git

SSH URLs provide access to a Git repository via SSH, a secure protocol. If you have a SSH key registered in your Github account, clone the project using this command:

git clone [e-mail]:tiago-web/Ecoleta.git

Install dependencies

yarn install or npm install

🏁 Getting Started

Run the following command in order to start the application in a development environment:

Frontend Initialization

yarn start or npm start

Backend Initialization

yarn dev or npm run dev

🔒 Dependencies

Important: These are only the most important ones.

Frontend dependencies

• react & react-dom
• react-router-dom

Backend dependencies

• express
• sqlite3

📮 FAQ

Question: What are the technologies used in this project?

Answer: The tecnologies used in this project are React, SQLite & Node.js.

🔨 Issues

Feel free to file a new issue with a respective title and description on the Ecoleta repository. If you already found a solution to your problem, i would appreciate to review your pull request!

📖 License

Released in 2020. This project is under the MIT license.

Made with ❤️ by Tiago Soriano 🚀