hbalardin / nlw-01-ecoleta

Projeto construído durante o Next Level Week #1, um evento de uma semana organizado pela RocketSeat.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

BannerEcoleta

♻️ Ecoleta

Seu marketplace de coleta de resíduos. Ajudamos pessoas a encontrarem pontos de coletas de forma eficiente.

GitHub license

Status: Concluído ✅


SobreFuncionalidadesTecnologiasExecutando o projetoLicençaVersões do README


📄 Sobre

O objetivo do Ecoleta é conectar empresas de coleta de resíduos, com pessoas que precisam de um local adequado para o descarte de lixo.

Este projeto foi desenvolvido durante a primeira NLW (Next Level Week).

A NLW é um evento online de uma semana, disponibilizado pela RocketSeat, focado em por a mão na massa. O conteúdo fica disponível apenas durante o evento.


🔝 Funcionalidades

Empresas podem registrar-se pela plataforma web, basta preencher o formulário.

Pelo aplicativo, os usuários podem navegar pelo mapa e encontrar pontos de coleta na sua região, podendo entrar contato com as empresas via whatsapp ou email.

WebDemonstration MobileDemonstration


🔨 Tecnologias

Estas são as principais tecnologias utilizadas na construção do projeto:


🚀 Executando o projeto

Antes de qualquer coisa, você precisa ter o Git e o Node.js instalado na sua máquina. Feito isso, você pode prosseguir.

📂 Instalando dependências

# Clone este repositório:
$ git clone https://github.com/hbalardin/nlw-01-ecoleta

# Acesse à pasta do projeto:
cd nlw-01-ecoleta

# Vá à pasta server:
cd server

# Instale as depêndencias:
npm install

# Vá à pasta web:
cd ../web

# Instale as depêndencias:
npm install

# Vá à pasta mobile:
cd ../mobile

# Instale as depêndencias:
npm install

# Volte à pasta do projeto:
cd ..

💾 Rodando o servidor (back-end)

Antes de rodar o servidor pela primeira vez, você precisa criar o banco de dados.

# Vá à pasta server:
cd server

# Crie o banco de dados:
npm run knex:migrate

# Preencha as tabelas:
npm run knex:seed

# Execute o server em modo de desenvolvimento:
npm run dev

💻 Rodando a aplicação web (front-end)

Com o servidor rodando, abra um novo terminal e entre na pasta do projeto.

# Vá à pasta web:
cd web

# Execute o site em modo de desenvolvimento:
npm run start

Caso a página não abrir automaticamente, acesse: http://localhost:3000


📱 Rodando o aplicativo (mobile)

Você pode optar por baixar o aplicativo expo em seu smartphone ou instalar um emulador.

  • Assista este vídeo da RocketSeat com o passo a passo para a instalação de um emulador:

Com o servidor e o emulador rodando, abra um novo terminal e entre na pasta do projeto.

# Vá à pasta mobile:
cd web

# <<Se você estiver utilizando emulador>>
# Crie a aplicação android (ou IOS):
npm run android # (ou IOS)

# <<Se você estiver utilizando seu smartphone>>
# Execute o aplicativo em modo de desenvolvimento:
npm run start

⚙️ Configurando IP

IPDemonstraction

Como no gif acima, substitua o "localhost" pelo endereço IP da sua máquina nestes três arquivos:

  1. mobile -> src -> config -> ip.ts
  2. server -> src -> config -> ip.ts
  3. web -> src -> config -> ip.ts

📋 Licença

Esse repositório está sobe a licença MIT.

Desenvolvido por Henrique Balardin dos Santos 🚀 Entre em contato!


🚩 Versões do README

About

Projeto construído durante o Next Level Week #1, um evento de uma semana organizado pela RocketSeat.

License:MIT License


Languages

Language:TypeScript 82.5%Language:CSS 15.4%Language:HTML 1.8%Language:JavaScript 0.3%