/EColeta-NLW01

♻️ _Ecoleta - Seu marketplace de coleta de resíduos!

Primary LanguageTypeScriptMIT LicenseMIT

EColeta

Desenvolvido durante a Next Level Week 1.0 da Rocketseat

Language Made by Lucca Radaeli GitHub last commit License Stargazers

🌟   Next Level Week   |    💻  Projeto   |    🚀   Tecnologias   |    🎆   Layout      

👨‍🏫   Executar   |    ➕   Contribuir   |    📝   Licença   |    📧  Contato


🌟 NLW - O que é?

A Next Level Week é uma semana prática com muito código, desafios, networking e um único objetivo: levá-lo ao próximo nível. Através do nosso método, você aprenderá novas ferramentas, aprenderá sobre novas tecnologias e descobrirá hacks que irão impulsionar sua carreira. Um evento online e totalmente gratuito que o ajudará a dar o próximo passo na sua evolução como desenvolvedor.

💻 Projeto

O Ecoleta visa conectar pessoas à companhias que coletam resíduos recicláveis como pilhas, lâmpadas, óleo de cozinha, etc...

Pela plataforma web o usuário consegue cadastrar novos pontos de coleta, passando informações básicas de endereço e contato, uma imagem e os itens que este ponto pode coletar.

Já pelo aplicativo móvel o usuário consegue encontrar no mapa os pontos de coleta localizados na cidade informada, filtrados pelos itens que estes pontos aceitam coletar.

Example

🚀 Tecnologias Utilizadas

Este projeto foi desenvolvido com as seguintes tecnologias:

🔖 Layout

Você pode visualizar o layout no Figma!

⚙️ Executando

Para baixar e executar esta aplicação você vai precisar de: Git, Docker, PostgreSQL e Node.js + Yarn.

🗄️ Executando a API (backend)

Run in Insomnia

# Clone este repositório:
$ git clone https://github.com/radaelilucca/EColeta-NLW01.git

# Entre na pasta do repositório, em seguida na pasta do backend:
$ cd EColeta-NLW01/backend

# Instale as dependências:
$ yarn install

# Suba um docker container com a imagem postgres
$ docker run --name some-postgres -e POSTGRES_PASSWORD=mysecretpassword -d postgres

# Crie uma database chamada ecoleta
$ CREATE DATABASE ecoleta 
# ou em algum client postgresql como Postico ou Postbird

# Preencha as variáveis ambiente no arquivo .env.example e renomei-o para '.env'.

# Execute as migrations e as seeds:
$ yarn setup-database

# Inicie a API:
$ yarn dev

# A API roda por padrão na porta 3333!

Para testes, utilize um cliente HTTP como o Insomnia ou Postman.

🌐 Executando o Frontend

# Clone este repositório:
$ git clone https://github.com/radaelilucca/EColeta-NLW01.git

# Entre na pasta do repositório, em seguida na pasta do mobile:
$ cd EColeta-NLW01/frontend

# Instale as dependências:
$ yarn install

# Execute o projeto em modo desenvolvimento:
$ yarn start

# Não se esqueça de preencher as variáveis ambiente no arquivo .env.example e renomeá-lo para '.env'.

# O frontend roda por padrão na porta 3000!

📱 Executando o Aplicativo Mobile

# Clone este repositório:
$ git clone https://github.com/radaelilucca/EColeta-NLW01.git

# Entre na pasta do repositório, em seguida na pasta do mobile:
$ cd EColeta-NLW01/mobile

# Instale as dependências:
$ yarn install

# Execute o projeto em modo desenvolvimento:
$ yarn start

Para testes, utilize um dispositivo físico com o aplicativo do Expo ou emuladores.

➕ Como contribuir

  • Primeiramente deixe uma ⭐;
  • Faça um fork deste 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.

Após o merge da sua PR você pode deletar sua branch por conta própria!

📝 Licença

This project is under the MIT license. See the LICENSE for details.

📧 Contato

Gostou do Projeto e quer conversar sobre? Me chama pra gente trocar uma idéia!

Parte dos créditos do readme vão para Daniel Obara. Obrigado, Daniel!

Made with ♥ by Lucca Radaeli 👋