Sua plataforma para transformar rotinas em conquistas. 🚀
Explore a documentação »
Reportar Bug
·
Solicitar Feature
- 🧠 Sobre o Projeto
- 🛠️ Tecnologias Utilizadas
- ⚙️ Começando
- 🚀 Roadmap Futuro
- 🤝 Como Contribuir
- 📄 Licença
HabitBoost é uma plataforma SaaS inovadora, desenhada para ajudar usuários a construir e manter hábitos positivos através da gamificação. Em um mundo onde a produtividade é chave, nós oferecemos uma ferramenta divertida e engajadora para criar rotinas, definir metas e acompanhar o progresso de forma visual e motivadora.
Por que criamos o HabitBoost?
- ✔ Alta Demanda: Aplicações de produtividade e hábitos são uma tendência de busca contínua.
- ✔ Potencial de Evolução: O projeto tem um vasto espaço para crescer com funcionalidades de gamificação, relatórios avançados, interações sociais e modelos de assinatura.
- ✔ Impacto Real: Pode ser transformado em um produto real, ajudando pessoas a alcançarem seu potencial máximo.
✅ Criação de Metas: Defina rotinas diárias e objetivos claros (ex: "Estudar 1h de Java", "Correr 3km"). ✅ Registro de Progresso: Marque tarefas como concluídas e veja sua evolução. ✅ Gamificação: Ganhe pontos, suba de nível e desbloqueie conquistas ao completar suas metas. ✅ Dashboards Visuais: Acompanhe sua performance com gráficos e estatísticas detalhadas. ✅ Compartilhamento Social: (em breve) Compartilhe suas conquistas com amigos e uma comunidade de apoio.
Este projeto foi construído utilizando as mais modernas tecnologias para garantir escalabilidade, segurança e performance.
- NestJS: Um framework Node.js progressivo para construir aplicações eficientes e escaláveis do lado do servidor.
- TypeScript: Para um código mais seguro, legível e manutenível.
- Docker: Para garantir um ambiente de desenvolvimento e produção consistente e isolado.
- PostgreSQL: Como nosso banco de dados relacional.
- TypeORM: Como nosso ORM para uma interação fluida com o banco de dados.
Para ter uma cópia do projeto rodando localmente, siga estes passos.
Certifique-se de ter os seguintes softwares instalados em sua máquina:
-
Clone o repositório:
git clone https://github.com/peixotim/HabitBoost.git cd HabitBoost -
Instale as dependências:
pnpm install
-
Configure as variáveis de ambiente:
cp .env.example .env
-
Inicie o banco de dados com Docker:
docker-compose up -d
-
Rode as migrações do banco de dados (se aplicável):
# Exemplo com Prisma # pnpm prisma migrate dev
-
Inicie a aplicação em modo de desenvolvimento:
pnpm run start:dev
A API estará disponível em http://localhost:3000.
Temos grandes planos para o HabitBoost!
- Sistema de Níveis e XP: Aprimorar a gamificação com um sistema de experiência mais robusto.
- Relatórios Avançados: Gerar relatórios semanais e mensais de performance.
- Funcionalidades Sociais: Permitir que usuários adicionem amigos e compartilhem progresso.
- Planos de Assinatura: Introduzir planos Premium para desbloquear funcionalidades exclusivas.
- Notificações Push: Enviar lembretes e mensagens de motivação.
Contribuições são o que tornam a comunidade de código aberto um lugar incrível para aprender, inspirar e criar. Qualquer contribuição que você fizer será muito apreciada.
- Faça um Fork do projeto.
- Crie uma Branch para sua feature (
git checkout -b feature/AmazingFeature). - Faça o Commit de suas mudanças (
git commit -m 'Add some AmazingFeature'). - Faça o Push para a Branch (
git push origin feature/AmazingFeature). - Abra um Pull Request.
Distribuído sob a licença MIT. Veja LICENSE para mais informações.
Feito com ❤️ por [Pedro Peixoto](https://github.com/peixotim)