README.md

Projeto   |    Demo   |    Tecnologias   |    Requerimentos   |    Como Executar   

Projeto

Objetivo

O Happy surgiu com a missão de trazer felicidade para todas as crianças que estão em instituições de acolhimento, unindo pessoas que se importam com elas aos lugares onde moram. Todo o desenvolvimento foi feito na semana do dia das crianças.

Funcionalidades

Frontend Web

• Instituições de acolhimento podem se cadastrar na plataforma através de um formulário no qual preenchem seus dados.
• Pessoas podem explorar institutos de acolhimento cadastrados na plataforma por meio de um mapa que mostra os institos próximos a onde elas estão.
• Pessoas podem entrar em contato direto com os institutos de acolhimento por whatsapp.

Frontend Mobile

• Instituições de acolhimento podem se cadastrar na plataforma através de um formulário no qual preenchem seus dados.
• Pessoas podem explorar institutos de acolhimento cadastrados na plataforma por meio de um mapa que mostra os institos próximos a onde elas estão.
• Pessoas podem entrar em contato direto com os institutos de acolhimento por whatsapp.

Demo da Aplicação Web

Demo da Aplicação Mobile

Tecnologias Aplicadas

Backend

O servidor foi construído em Node.js utilizando o SQLite3 para administrar um banco de dados local e o Typeorm como Object Relational Mapper oficial. Para criar e gerir as rotas foi utilizado o micro-framework Express.

Frontend Web

Para construir o frontend web foi utilizado o framework Next.js, baseado na biblioteca ReactJS, que adiciona novas funcionalidades à aplicação frontend, como Server Side Rendering e Static Site Generation, e o axios como cliente HTTP para consumir os dados do servidor.

Frontend Mobile

No projeto do aplicativo utilizei a ferramenta expo para criar meu projeto em React Native, novamente utilizando o axios como cliente HTTP para consumir os dados do servidor.

Requerimentos

Para conseguir rodar o projeto em sua máquina é necessário ter as seguintes ferramentas instaladas

• Node.js
• NPM ou Yarn
• Docker
• Expo

Como Executar

Clonando o projeto

# Clonando o projeto para a máquina
git clone https://github.com/Preddo/happy.git
# Vai para a pasta do projeto happy
cd happy

Iniciando Backend

# Vai para a pasta server
cd server
# Instala as dependências
yarn
# Cria um container com a imagem do Postgres ! Importante criar uma database dentro do container com o nome happy
docker run --name nlw -e POSTGRES_PASSWORD=docker -p 5432:5432 -d postgres
# Roda as migrations do banco de dados
yarn typeorm migration:run
# Executa o servidor
yarn start

Iniciando Frontend Web

# Volta para a pasta happy
cd ..
# Vai para a pasta web
cd web
# Instala as dependências do frontend web
yarn
# Executa o frontend web
yarn start

Iniciando Frontend Mobile

# Volta para a pasta happy
cd ..
# Vai para a pasta mobile
cd mobile
# Instala as dependências do frontend mobile
yarn
# Executa o frontend mobile
yarn start

📝 Licença

Este projeto está sob a licença MIT.