🚧 Ecoleta ♻️ Concluído 🚀 🚧

Sobre • Funcionalidades • Layout • Como executar • Tecnologias • Contribuidores • Autor • Licença

💻 Sobre o projeto

♻️ Ecoleta - é 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.

Projeto desenvolvido durante a NLW - Next Level Week oferecida pela Rocketseat. O NLW é uma experiência online com muito conteúdo prático, desafios e hacks onde o conteúdo fica disponível durante uma semana.

⚙️ Funcionalidades

• [x] Empresas ou entidades podem se cadastrar na plataforma web enviando:

  • [x] uma imagem do ponto de coleta
  • [x] nome da entidade, email e whatsapp
  • [x] e o endereço para que ele possa aparecer no mapa
  • [x] 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

• [x] Os usuários tem acesso ao aplicativo móvel, onde podem:

  • [x] navegar pelo mapa para ver as instituições cadastradas
  • [x] entrar em contato com a entidade através do E-mail ou do WhatsApp

🎨 Layout

O layout da aplicação está disponível no Figma:

Mobile

Web

🚀 Como executar o projeto

Este projeto é divido em três partes:

1. Backend (pasta server)
2. Frontend (pasta web)
3. Mobile (pasta mobile)

💡Tanto o Frontend quanto o Mobile precisam que o Backend esteja sendo executado para funcionar.

Pré-requisitos

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

🎲 Rodando o Backend (servidor)

# Clone este repositório
$ git clone [email protected]:tgmarinho/README-ecoleta.git

# Acesse a pasta do projeto no terminal/cmd
$ cd README-ecoleta

# 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 

🧭 Rodando a aplicação web (Frontend)

# Clone este repositório
$ git clone [email protected]:tgmarinho/README-ecoleta.git

# Acesse a pasta do projeto no seu terminal/cmd
$ cd README-ecoleta

# 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

🛠 Tecnologias

As seguintes ferramentas foram usadas na construção do projeto:

Website (React + TypeScript)

• React Router Dom
• React Icons
• Axios
• Leaflet
• React Leaflet
• React Dropzone

Veja o arquivo package.json

Server (NodeJS + TypeScript)

• Express
• CORS
• KnexJS
• SQLite
• ts-node
• dotENV
• Multer
• Celebrate
• Joi

Veja o arquivo 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

Veja o arquivo package.json

Utilitários

• Protótipo: 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
• Teste de API: Insomnia
• Ícones: Feather Icons, Font Awesome
• Fontes: Ubuntu, Roboto

👨‍💻 Contribuidores

💜 Um super thanks 👏 para essa galera que fez esse produto sair do campo da ideia e entrar nas lojas de aplicativos :)

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 🚀

💪 Como contribuir para o projeto

1. Faça um fork do projeto.
2. Crie uma nova branch com as suas alterações: git checkout -b my-feature
3. Salve as alterações e crie uma mensagem de commit contando o que você fez: git commit -m "feature: My new feature"
4. Envie as suas alterações: git push origin my-feature

Caso tenha alguma dúvida confira este guia de como contribuir no GitHub

🦸 Autor

_{Thiago Marinho}

📝 Licença

Este projeto esta sobe a licença MIT.

Feito com ❤️ por Thiago Marinho 👋🏽 Entre em contato!

Versões do README

Português 🇧🇷 | Inglês sem emojis 🇺🇸 | Portugues sem logo 🇧🇷