Ecoleta - NextLevelWeek 1.0 🚀

Projeto   |    Tecnologias   |    Como Usar   |    Como contribuir   |    Licença

💻Projeto

O projeto Ecoleta foi desenvolvido na NextLevelWeek 1.0 🚀 oferecido pela Rocketseat. É um projeto completo com backend (API), Aplicação Web e Aplicação Mobile.

Na Aplicação Web é possível cadastrar pontos de coleta (Ecopontos, Supermercados, Prefeituras) de materiais que necessitam de descarte correto (Lâmpadas, Pilhas, Baterias, Papéis, Papelão, Resíduos Eletrônicos, Resíduos Organicos e Óleo de Cozinha).
Já o servidor backend gerencia os dados cadastros e disponíbiliza o acesso aos dados via API REST
No Aplicativo Mobile é possível consultar os locais cadastrados na aplicação web pelo mapa filtrando pelos tipos de materiais que o local coleta.

🛠Tecnologias

Server (API)

• Node.JS
• TypeScript
• Express
• SQLite
• Knex
• Multer
• Cors
• Celebrate

Web

• ReactJS
• TypeScript
• Axios
• Leaflet
• ReactDropzone

Mobile

• React Native
• Expo
• Axios
• Mail Composer
• Map View

🚀Como Usar

Para usar a aplicação, você precisa de Git e Node.js instalado no seu computador. Com as ferramentas instaladas, basta seguir os passos a seguir:

Clonar o projeto

# Clonar o projeto Ecoleta do repositório
$ git clone https://github.com/cassiodoria/ecoleta

Server (API)

# Entre na pasta server
$ cd ecoleta/server

# Instale as dependências
$ npm install

# Crie o arquivo de banco de dados (database.sqlite) e suas tabelas
$ npm run knex:migrate

# Popule os dados da tabela items (Lâmpadas, Pilhas e Baterias, Papéis e Papelão, Resíduos Eletrônicos, Resíduos Organicos e Óleo de Cozinha)
$ npm run knex:seed

# Executa o servidor no endereço localhost a porta 3333
$ npm run dev

Para testar se o servidor subiu corretamente e os dados do banco de dados estão corretos, basta fazer um GET (ou acessar via browser) no endereço http://localhost:3333/items e verificar se os itens (Lâmpadas, Pilhas e Baterias, Papéis e Papelão, Resíduos Eletrônicos, Resíduos Organicos e Óleo de Cozinha) são retornados.

Exemplo usando a ferramenta Insomnia

Web

# Entre na pasta web
$ cd ecoleta/web

# Instale as dependências
$ npm install

# Execute a aplicação web. A aplicação será aberta no endereço localhost na porta 3000
$ npm start

Mobile

Para testar a aplicação mobile, é possível usar um emulador ou a ferramenta Expo no seu celular.

# Entre na pasta mobile
$ cd ecoleta/mobile

# Instale as dependências
$ npm install

# Execute a aplicação mobile. A ferramenta Expo irá abrir. Basta escanear o qrcode no próprio terminal ou na página do Expo que irá abrir no browser. 
$ npm start

# Se ocorrer algum problema relacionado a fonte, execute o comando a seguir:
$ expo install expo-font @expo-google-fonts/ubuntu @expo-google-fonts/roboto

Exemplo usando a ferramenta Expo

🤔Como contribuir

• Faça um fork desse repositório;
• Cria uma branch com a sua feature: git checkout -b minha-feature;
• Faça commit das suas alterações: git commit -m 'feat: Minha nova feature';
• Faça push para a sua branch: git push origin minha-feature.

Depois que o merge da sua pull request for feito, você pode deletar a sua branch.

📝Licença

Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.

Feito com ♥ by Cássio Dória