📰️ Índice

• Como usar
• Sobre
• Tecnologias Utilizadas
• Preview
• Para baixar e reproduzir o projeto
• Como contribuir
• Licença

📚️ Sobre

Ecoleta é um app web e mobile criado com o intuito de ajudar as pessoas a encontrarem pontos de coleta de reśiduos próximas a elas.

Essa aplicação foi resultado da Next Level Week da Rocketseat.

👨‍💻️ Tecnologias Utilizadas

O projeto foi desenvolvido utilizando as seguintes tecnologias

• TypeScript
• Node.js
• ReactJS
• React Native
• Expo
• Imgur API in Typescript - Créditos para @rmp135

🔎️ Preview

O mockup utilizado para o projeto está disponivel no Figma

🖥️ Web Preview

📱️ Mobile Preview

♻️ Como usar

🖥️ Web

Você pode acessar a versão web pelo link http://lucasliet.github.io/Ecoleta tanto pelo computador quanto pelo celular, ele também é instalavel como PWA, adicionando um atalho no celular para abrir como um app

📱️ Mobile

A melhor forma de testar e usar a versão mobile é instalado o app do Expo, infelizmente por enquanto esse suporte só é fornecido pelo APP android, porém se reproduzir o projeto no seu PC, poderá testar no iPhone também ❤️

após abrir o app e clicar em Scan QR Code, aponte a camera para esse QR Code

⚙️ Para baixar e reproduzir o projeto

• Pré-requisitos

  • É necessário ter instalado o git, caso esteja no Windows, baixe o instalador,no Ubuntu e derivados pode ser instalado com

  # apt install git -y
  

  • É necessário possuir o Node.js instalado
  • Também, é preciso ter um gerenciador de pacotes seja o NPM ou Yarn.
  • Por fim, é essencial ter o Expo CLI instalado de forma global na máquina

  # yarn add global expo-cli  
  

  • Caso prefira pode instalar o App do expo, no seu Android ou iPhone, para testar direto do seu celular!

1. Faça um clone:

  $ git clone https://github.com/lucasliet/Ecoleta.git

2. Executando a Aplicação:

  # Instale as dependências
  $ yarn install

  ## Crie o banco de dados
  $ cd server
  $ yarn knex:migrate
  $ yarn knex:seed

  # Inicie a API
  $ yarn dev

  # Inicie a aplicação web
  $ cd web
  $ yarn start

  # Inicie a aplicação mobile
  $ cd mobile
  $ yarn start

para iniciar o app mobile leia o QRCode na tela do expo instalado no seu celular, iPhone ou Android, ou aperte A para rodar direto do emulador se tiver instalado

🤝️ Como contribuir

• Faça um Fork desse repositório,
• Crie uma branch com a sua feature: git checkout -b my-feature
• Faça um commit com suas mudanças: git commit -m 'feat: My new feature'
• Faça um push da sua branch: git push origin my-feature
• Abra um Pull Request no github explicando suas mudanças e o motivo para elas

📝️ Licença

Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.

---

Feito com ❤️ por Lucas Souza