/Ecoleta

Projecto construído durante o Next Level Week 1 - Ecoleta by @Rocketseat

Primary LanguageTypeScript

NextLevelWeek

🚧 NextLevelWeek 1.0 🚀 em construção... 🚧

GitHub language count Repository size Siga no Twitter GitHub last commit License Stargazers

💻 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.

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

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.

🎨 Layout

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

Made by tgmarinho

Mobile

NextLevelWeek NextLevelWeek

Web

NextLevelWeek NextLevelWeek

🛠 Tecnologias

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

🚀 Como executar o projeto

Podemos considerar este projeto como sendo divido em três partes:

  1. Back End (pasta server)
  2. Front End (pasta web)
  3. Mobile (pasta mobile)

💡Tanto o Front End quanto o Mobile precisam que o Back End 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 Back End (servidor)

# Clone este repositório
$ git clone https://github.com/tgmarinho/nlw1

# Acesse a pasta do projeto no terminal/cmd
$ cd nlw1

# 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 (Front End)

# Clone este repositório
$ git clone https://github.com/tgmarinho/nlw1

# Acesse a pasta do projeto no seu terminal/cmd
$ cd nlw1

# 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

📱Rodando a aplicação mobile

🚧 Em construção... 🚧

😯 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

📝 Licença

Este projeto esta sobe a licença MIT.

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