♻️ ECOLETA
About • Features • Layout • How it works • Tech Stack • Contributors • Author • License
♻️ Ecoleta - is a way to connect companies and entities that collect organic and inorganic waste to people who need to dispose of their waste in an ecological way. Project developed during ** NLW - Next Level Week ** offered by Rocketseat. NLW is an online experience with lots of practical content, challenges and hacks where the content is available for a week.
-
Companies or entities can register on the web platform by sending:
- an image of the collection point
- entity name, email and whatsapp
- and the address so that it can appear on the map
- in addition to selecting one or more collection items:
- lamps
- Batteries
- papers and cardboard
- electronic waste
- organic waste
- kitchen oil
-
Users have access to the mobile application, where they can:
- browse the map to see the registered institutions
- contact the entity via E-mail or WhatsApp
The application layout is available on Figma:
This project is divided into three parts:
- Backend (server folder)
- Frontend (web folder)
- Mobile (mobile folder)
Both Frontend and Mobile need the Backend to be running to work.
Before you begin, you will need to have the following tools installed on your machine: [Git] (https://git-scm.com), [Node.js] (https://nodejs.org/en/). In addition, it is good to have an editor to work with the code like [VSCode] (https://code.visualstudio.com/)
# Clone this repository
$ git clone [email protected]:tgmarinho/README-ecoleta.git
# Access the project folder cmd/terminal
$ cd README-ecoleta
# go to the server folder
$ cd server
# install the dependencies
$ npm install
# Run the application in development mode
$ npm run dev:server
# The server will start at port: 3333 - go to http://localhost:3333
# Clone this repository
$ git clone [email protected]: tgmarinho / README-ecoleta.git
# Access the project folder in your terminal
$ cd README-ecoleta
# Go to the Front End application folder
$ cd web
# Install the dependencies
$ npm install
# Run the application in development mode
$ npm run start
# The application will open on the port: 3000 - go to http://localhost:3000
The following tools were used in the construction of the project:
Website (React + TypeScript)
See the file package.json
Server (NodeJS + TypeScript)
See the file package.json
Mobile (React Native + TypeScript)
- Expo
- Expo Google Fonts
- React Navigation
- React Native Maps
- Expo Constants
- React Native SVG
- Axios
- Expo Location
- Expo Mail Composer
See the file package.json
- Prototype: Figma → Protótipo (Ecoleta)
- API: IBGE API → API de UFs, API de Municípios
- Maps: Leaflet
- Editor: Visual Studio Code → Extensions: SQLite
- Markdown: StackEdit, Markdown Emoji
- Commit Conventional: Commitlint
- API Test: Insomnia
- Icons: Feather Icons, Font Awesome
- Fonts: Ubuntu, Roboto
A big thanks to this group that made this product leave the field of idea and enter the app stores :)
You are an awesome team! :)
Diego Fernandes |
Cleiton Souza |
Robson Marques |
Claudio Orlandi |
Vinícios Fraga |
Hugo Duarte 🌐 |
Joseph Oliveira |
Guilherme Rodz |
Mayk Brito |
João Paulo |
Luke Morales |
Luiz Batanero |
- Fork the project.
- Create a new branch with your changes:
git checkout -b my-feature
- Save your changes and create a commit message telling you what you did:
git commit -m" feature: My new feature "
- Submit your changes:
git push origin my-feature
If you have any questions check this guide on how to contribute
Thiago Marinho
This project is under the license MIT.
Made with love by Thiago Marinho 👋🏽 Get in Touch!
Portuguese | English without emojis | Portugueses without logo