📖 Happy

O projeto foi desenvolvido na Next Level Week,evento que ocorreu durante os dias 12 a 18 de Outubro de 2020, ministrado pela @Rocketseat. O Intuito do projeto é desenvolver uma aplicação para unir grupos de pessoas com interesse em efetuar visitações a orfanatos. Será possível cadastrar os orfanatos da sua cidade, além de pesquisar os que existem na região e obter alguns detalhes sobre o mesmo.

📋 Índice

• 🖥 Preview
• 🚀 Tecnologias utilizadas
• ⌨ Como executar o projeto

---

🖥 Preview

Página inicial

Localização da região

Informações sobre o orfanato

---

🚀 Tecnologias

• Web

  • React
  • Typescript
  • Leaflet
  • React Leaflet
  • Open Street Map ou Mapbox

• Backend

  • Nodejs
  • Express
  • Typeorm
  • Multer
  • Yup

• Mobile

  • Expo
  • React Native
  • Axios

---

⌨ Executando o Projeto

Este repositório é um monorepo, onde vamos ter o código do backend,frontend e do app mobile, portanto, cada um terá suas próprias dependências que devem ser baixadas individualmente.

Baixe o projeto:

  git clone https://github.com/igorishere/NLW-3.git

Server

Entre no diretório e baixe as dependências

  cd backend\web 
   yarn install ou npm install

Caso seja a primeira execução do backend, execute as migrations para atualizar o banco de dados:

  yarn typeorm migration:run
  # ou
  npm typeorm migration:run

Procure o arquiv .env.exemple, faça uma cópia e renomeie para .env, depois edite ele e coloque o IP da sua máquina

   # SERVER HOST

   SERVER_HOST = http://{seu Ip aqui}:3333
   
   # ex.: SERVER_HOST = http://192.168.0.1:3333

Feito isso, para subir o servidor execute:

  yarn start
  # ou
  npm start

Web

Para rodar o frontend na versão Web:

Entre no diretório

  cd frontend\web 

Baixe todas as dependências do projeto:

  yarn install ou npm install 

Procure o arquivo .env.exemple, faça uma cópia e renomeie para .env, depois edite ele e coloque o endereço do servidor criado antes

  # API
  
  REACT_APP_API_HOST = http://{ip do servidor}:3333
  
  ex.: REACT_APP_API_HOST = http://192.168.0.1:3333

Execute a aplicação

  yarn start 
  # ou 
  npm start

Mobile

Para rodar o app Mobile da aplicação:

Entre no diretório

  cd frontend\mobile 

Baixe todas as dependências do projeto:

  yarn install ou npm install 

Procure o arquivo .env.exemple, faça uma cópia e renomeie para .env, depois edite ele e coloque o endereço do servidor criado antes

  # API

  API_HOST = http://{IP do servidor aqui}:3333
  
  ex.: API_HOST = http://192.168.0.1:3333

Execute a aplicação

  yarn start 
  # ou 
  npm start

Baixe o aplicativo do Expo no seu celular e escaneie o QRcode que será apresentado no servidor para rodar o app no dispositivo

• Expo para Android
• Expo para IOS