Happy

📌 Index

• Sobre o projeto
• Screenshots
• Techs
• Instalação e Start
• Contribuições
• License

❔ Sobre o projeto

Uma plataforma para facilitar o encontro de orfanatos por pessoas que querem visita-los.

O projeto está em desenvolvimento na Next Level Week 3

🛠 Techs

• Web

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

• Backend

  • Nodejs
  • Express
  • Typeorm
  • Multer
  • Yup

⚙ Instalação e Start

Este repositório é um monorepo, portanto, manterá os fontes do projeto Web, API e Mobile. Cada parte do projeto tem suas dependências e é necessário instala-las individualmente antes da execução, para isso certifique-se de que tenha NPM ou YARN instalado em seu ambiente, além, é claro, o repositório clonado em seu ambiente.

Clone o repositório com:

> git clone https://github.com/tatucloud/happy.git

As demonstrações utilizam YARN por padronização, mas, caso use NPM, basta substituir onde estiver escrito yarn por npm.

Instalando dependências do projeto web:

> cd happy/web
> yarn install

Para executar o projeto web, use no diretório correspondente:

> yarn start

Acesse: http://127.0.0.1:3000/ para visualizar.

Instalando dependências do projeto backend:

> cd happy/backend
> yarn install

Para executar o projeto backend é necessário criar o banco de dados com todas as tabelas utilizadas, para isso, use no diretório correspondente:

> yarn typeorm migration:run
> yarn dev

Para executar o projeto mobile é necessário criar o banco de dados com todas as tabelas utilizadas, para isso, use no diretório correspondente:

> yarn start

📜 License

O projeto está sobre a licença MIT