A iniciativa Helpcife é uma plataforma para divulgação de iniciativas de caridade, que tem o intuito de promover e facilitar o apoio a causas sociais e organizações beneficentes. Nossa plataforma online serve como um hub centralizado para conectar indivíduos, empresas e organizações com iniciativas de caridade em Recife.
Nossa aplicação utiliza o Turbo.js para unificar tanto o front-end quanto o back-end em um único repositório, portanto, não se preocupe em configurar o backend antes de poder executá-lo localmente. Basta executar npm i e, em seguida, turbo run dev na pasta externa, e você estará pronto para começar =)
Para executar nossa aplicação na sua máquina, você pprecisa apenas do node.
npm run install
turbo run devjest run testsAté o momento, estamos testando se o aplicativo em execução pode acessar todos os pontos de extremidade do aplicativo (obter iniciativas, enviá-las, fazer patch/atualizações, e assim por diante).
Verifica se as melhores práticas e o estilo de codificação correto foram utilizados.
Nosso aplicativo é desenvolvido seguindo dois princípios de design principais: modularização por meio de componentes para a parte do front-end
e a factorização das funções no lado do back-end.- Backend -> Render
- FrontEnd -> Vercel (link: https://helpcife-qm1h65xlc-matheusmalta002.vercel.app/)
Através do Turbo, executamos o comando "turbo run build" para facilitar os testes de implantação.
- Banco de dados -> Render
- Armazenamento de imagens -> Firebase
- documentação da API -> Swagger (link : https://helpcifeapi.onrender.com/api)
- React.ts, Nest.ts, Postgres, typeORM, jest e styled components.
- MIT license
Se você deseja contribuir, certifique-se de fazer um fork e escrever um código limpo para que possamos revisá-lo e implementá-lo na produção =)
As versões podem ser encontradas nas diferentes branches geradas seguindo nosso padrão: featureSendoDesenvolvida-NomeDoProjeto
Este projeto está licenciado sob a Licença MIT 1.0 Universal.
Agradecemos a todos cujo código foi utilizado. Nosso objetivo é ajudar as pessoas necessitadas em Recife e, no futuro, em todo o Brasil!