Skip to content

Latest commit

 

History

History
173 lines (123 loc) · 4.01 KB

README.md

File metadata and controls

173 lines (123 loc) · 4.01 KB
Raw

Seu marketplace de coleta de resíduos

GitHub language count GitHub top language GitHub repo size

Run in Insomnia}

Sobre   |    Tecnologias   |    Como usar   |    Como construir

📌 Sobre

Projeto multiplataforma, web e mobile, desenvolvido durante a Next Level Week #1, promovida pela Rocketseat. Inspirado na semana do meio ambiente, o projeto tem por objetivo ajudar pessoas a encontrarem pontos de coleta de resíduos de forma eficiente. Foi desenvolvido um APIRestfull para alimentar os dados do front-end. A aplicação consome dados da API do IBGE para listar estados e cidades por estado, bem como consome a API do Leaflet para exibição do mapa.

🚀 Tecnologias

O Projeto foi desenvolvido com as seguintes tecnologias.

Back-end

  • TypeScript
  • NodeJS
  • Express
  • SQLite
  • Celebrate
  • Cors
  • Knex (migrations)
  • Multer

Front-end Web

  • TypeScript
  • ReactJS
  • Axios
  • Leaflet
  • React DOM
  • React Dropzone
  • React Icons
  • React Router DOM

Front-end mobile

  • TypeScript
  • ReactJS
  • React Native
  • Axios
  • Expo
  • Expo Location
  • Expo Mail Composer
  • React DOM
  • React Native Maps
  • React Native Location

Layout

Layout de todas as telas disponível no Figma.

📁 Como usar

Para clonar e usar o este projeto será necessário ter Git, Node.js e Yarn instalados.

Instalação da API (server)

# Clonar o repositório
$ git clone https://github/piiiiva/ecoleta-app

# Entrar no diretório
$ cd ecoleta-app/server

# Instalar as dependências
$ npm install

# Rodar os migrates
$ npm knex:migrate

# Rodar os seeds
$ npm knex:seed

# Iniciar o servidor
$ npm run dev

# É preciso verificar o seu IP e alterar os arquivos 
-> server/src/controllers/ItemsController.ts conforme o seu IP
-> server/src/controllers/PointsController.ts conforme o seu IP

# Rodando na porta 3333
# Disponível em http://localhost:3333

Instalação front-end (web)

# Clonar o repositório
$ git clone https://github/piiiiva/ecoleta-app

# Entrar no diretório
$ cd ecoleta-app/web

# Instalar as dependências
$ npm install

# Iniciar a aplicação
$ npm start

# Rodando na porta 3333
# Disponível em http://localhost:3333

Instalação front-end (mobile)

# Clonar o repositório
$ git clone https://github/piiiiva/ecoleta-app

# Entrar no diretório
$ cd ecoleta-app/mobile

# Instalar as dependências
$ npm install

# Iniciar a aplicação
$ npm start

# Escanear o QRcode do Expo no terminal ou na página web

# É preciso verificar o seu IP e alterar os arquivos 
-> mobile/src/services/api.ts conforme o seu IP

# Rodando na porta 3333
# Disponível em http://seuIP:3333

🛠 Como construir

Documentação dos principais pontos da NLW e da construção passo a passo da aplicação aqui!

Desenvolvido com 💚 por Rodrigo Piva