📌 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

📸 Screenshots

Tela Web

🛠 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/matheusfelipeog/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 completo é necessário ter um token de autenticação da API do Mapbox. Acesse sua conta no site e crie um token para ser utilizado no projeto. Com o token em mãos, crie um arquivo .env e coloque seu token como valor da chave REACT_APP_MAPBOX_TOKEN.

Exemplo:

REACT_APP_MAPBOX_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Agora starte o projeto em seu ambiente com:

> 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

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

🤝 Contribuições

Siga os passos abaixo para contribuir:

1. Faça o fork do projeto (https://github.com/matheusfelipeog/happy)

2. Clone o seu fork para sua maquína (git clone https://github.com/user_name/happy.git)

3. Crie uma branch para realizar sua modificação (git checkout -b feature/name_new_feature)

4. Adicione suas modificações e faça o commit (git commit -m "Descreva sua modificação")

5. Push (git push origin feature/name_new_feature)

6. Crie um novo Pull Request

7. Pronto, agora só aguardar a análise 🚀

📜 License

O projeto está sobre a licença MIT ❤️

Gostou? Deixe uma estrelinha para ajudar o projeto ⭐