Ecoleta - The easiest way to throw away your trash

About the project   |    Technologies   |    Getting started   |    How to contribute   |    License

♻️ About the project

This project was developed on the Next Level Week event by Rocketseat  🚀💜

With the idea to help world ecosystem, this software provide a flow to create recyclable garbage collection points and show in a map around you. In the end, you can send a text message using the whatsapp or an email, and make the world better without trash.

🚀 Technologies

Technologies that I used to develop this api

• Node.js
• ReactJS
• React Native
• TypeScript
• React Leaflet
• Expo
• Express
• Knex
• SQLite
• React Router DOM
• React Navigation
• React Icons
• EditorConfig
• React Native Picker

💻 Getting started

Import the Insomnia.json on Insomnia App or click on Run in Insomnia button

Requirements

• Node.js
• Yarn or npm
• Expo

Clone the project and access the folder

$ git clone https://github.com/puera/ecoleta.git && cd ecoleta

Follow the steps below

Backend

# Starting from the project root folder, go to server folder
$ cd server

# Install the dependencies
$ yarn

# Use the script to run the migrations
$ yarn knex:migrate

# Use the script to run the seeds
$ yarn knex:seed

# To finish, run the api service
$ yarn dev

# Well done, project is started!

Web

Obs.: Before to continue, be sure to have the API running

# Starting from the project root folder, go to frontend web folder
$ cd frontend

# Install the dependencies
$ yarn

# Be sure the file 'src/services/api.ts' have the IP to your API

# Start the client
$ yarn start

Mobile

Obs.: Before to continue, be sure to have the API running

# Starting from the project root folder, go to mobile folder
$ cd mobile

# Install the dependencies
$ yarn

# Be sure the file 'src/services/api.ts' have the IP to your API

# Start the expo service and scan the QR code with Expo Client
$ yarn start

🤔 How to contribute

Make a fork of this repository

# Fork using GitHub official command line
# If you don't have the GitHub CLI, use the web site to do that.

$ gh repo fork puera/ecoleta

Follow the steps below

# Clone your fork
$ git clone your-fork-url && cd ecoleta

# Create a branch with your feature
$ git checkout -b my-feature

# Make the commit with your changes
$ git commit -m 'feat: My new feature'

# Send the code to your remote branch
$ git push origin my-feature

After your pull request is merged, you can delete your branch

📝 License

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

---

Made with 💜  by Renann Souza 👋