Ecollect - 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 environmentally friendly way.
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 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 will have access to the mobile app, where they will be able to:
- browse the map to see registered companies
- contact the entity via E-mail or WhatsApp
The following tools were used in the construction of the project:
We can consider this project as being divided into three parts:
- Back End (server folder)
- Front End (web folder)
- Mobile (mobile folder)
💡Both Front End and Mobile need the Back End to be running to function.
Before starting, you will need to have the following tools installed on your machine: Git, Node.js. Also it's nice to have an editor to work with the code like VSCode
# Clone this repo
$ git clone https://github.com/sacul/ecollect
# Change current folder to project folder
$ cd Ecollect
# Go to server folder
$ cd server
# Install dependencies
$ npm install
# Run on dev mode
$ npm run dev:server
# Server should start on port 3333. Go to http://localhost:3333 # Clone this repo
$ git clone https://github.com/sacul/ecollect
# Change current folder to project folder
$ cd Ecollect
# Go to web folder
$ cd web
# Install dependencies
$ npm install
# Run on dev mode
$ npm run start
# App shouçd run on port 3000. Go to http://localhost:3000# Clone this repo
$ git clone https://github.com/sacul/ecollect
# Change current folder to project folder
$ cd Ecollect
# Go to mobile folder
$ cd mobile
# Install dependencies
$ npm install
# Run app using Expo and follow Expo instructions
$ npm start- Fork the project.
- Create a new branch with your changes:
git checkout -b my-feature - Save the changes and create a commit message describing what you've done:
git commit -m "feature: My new feature" - Push your changes:
git push origin my-feature
If you have any questions, check out this GitHub Contribution Guide
Project developed during NLW - Next Level Week offered by Rocketseat.
♻️ Ecollect - é uma forma de conectar empresas e entidades de coleta de resíduos orgânicos e inorgânicos as pessoas que precisam descartar seus resíduos de maneira ecológica.
As empresas ou entidades poderão se cadastrar na plataforma web enviando:
- uma imagem do ponto de coleta
- nome da entidade, email e whatsapp
- e o endereço para que ele possa aparecer no mapa
- além de selecionar um ou mais ítens de coleta:
- lâmpadas
- pilhas e baterias
- papéis e papelão
- resíduos eletrônicos
- resíduos orgânicos
- óleo de cozinha
Os usuários terão acesso ao aplicativo móvel, onde poderão:
- navegar pelo mapa para ver as instituições cadastradas
- entrar em contato com a entidade através do E-mail ou do WhatsApp
As seguintes ferramentas foram usadas na construção do projeto:
Podemos considerar este projeto como sendo divido em três partes:
- Back End (pasta server)
- Front End (pasta web)
- Mobile (pasta mobile)
💡Tanto o Front End quanto o Mobile precisam que o Back End esteja sendo executado para funcionar.
Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js. Além disto é bom ter um editor para trabalhar com o código como VSCode
# Clone este repositório
$ git clone https://github.com/sacul/ecollect
# Acesse a pasta do projeto no terminal/cmd
$ cd Ecollect
# Vá para a pasta server
$ cd server
# Instale as dependências
$ npm install
# Execute a aplicação em modo de desenvolvimento
$ npm run dev:server
# O servidor inciará na porta:3333 - acesse http://localhost:3333 # Clone este repositório
$ git clone https://github.com/sacul/ecollect
# Acesse a pasta do projeto no seu terminal/cmd
$ cd Ecollect
# Vá para a pasta da aplicação Front End
$ cd web
# Instale as dependências
$ npm install
# Execute a aplicação em modo de desenvolvimento
$ npm run start
# A aplicação será aberta na porta:3000 - acesse http://localhost:3000# Clone este repositório
$ git clone https://github.com/sacul/ecollect
# Acesse a pasta do projeto no terminal/cmd
$ cd Ecollect
# Vá para a pasta mobile
$ cd mobile
# Instale as dependências
$ npm install
# Execute a aplicação usando o Expo e siga as instruções
$ npm start- Faça um fork do projeto.
- Crie uma nova branch com as suas alterações:
git checkout -b my-feature - Salve as alterações e crie uma mensagem de commit contando o que você fez:
git commit -m "feature: My new feature" - Envie as suas alterações:
git push origin my-feature
Caso tenha alguma dúvida confira este guia de como contribuir no GitHub
Projeto desenvolvido durante a NLW - Next Level Week oferecida pela Rocketseat.