j4ndo/ecoleta

Ecoleta is a Web and Mobile application to help people find collection points for recycling in their city or region.

Project developed in Next Level Week #01

Summary

• About
• Technologies
• How to Use
• How to Contribute

🔖 About

Ecoleta is a Web and Mobile application to help people find collection points for recycling in their city or region.

🚀 Technologies Used

The project was developed using the following technologies

• TypeScript
• Knex
• Node.js
• ReactJS
• React Native

🎨 Figma

Design: Project Link

🔥 How to Use

❗ Installation - Back-End (Server/API)

You must to clone the project in your computer. For install the dependencies and run the Server (develope mode) you must execute:

cd server
yarn install ou npm install
yarn dev ou npm dev

❗ Installation - Front-End (Web Application)

To start the Frontend of React use the commands:

cd web
yarn install ou npm install
yarn start ou npm start

Once the process is over, the page localhost:3000 will automatically open in your browser, containing the project developed.

❗ Mobile

To view the mobile application with React Native, first you need to put the IP of your server (or computer) in the file src / services / api.js, and then execute the commands:

# You do NOT need to run the bottom line if you already have Expo (CLI) installed
yarn global add install expo-cli
cd mobile
yarn install
yarn start

Once the process is over, the page localhost:19002 will automatically open in your browser. Connect your emulator, or test the application via LAN: download the * Expo * application from the Play Store or App Store and then scan the QR code.

❗ Insomnia

To test the Ecoleta API, download and install Insomnia and then click on Workspace → Import/Export → Import Data → From File → and select the file Insomnia_export.json from this repository.

♻️ How to contribute

• First, leave a ⭐ if you liked it!
• Make a Fork from this repository;
• Create a branch with your feature: git checkout -b my-feature
• Commit the changes: git commit -m 'feat: My new feature'
• Push your branch: git push origin my-feature

📝 License

This project use MIT license, see the file LICENSE for more details

---

Made with 💜 by Janderson Fonseca