Skip to content

Daniel-Moraes/Katholiks

Repository files navigation

🙏 KATHOLIKS - App Gamificado para Oração Católica

Flutter Firebase Dart

Uma plataforma completa para a vida espiritual católica, combinando tradição e tecnologia moderna


🎯 Visão Geral

O KATHOLIKS é um aplicativo móvel revolucionário que gamifica a experiência de oração católica, tornando a vida espiritual mais engajante e interativa para fiéis de todas as idades. Combinamos a rica tradição católica com tecnologia moderna para criar uma experiência única de crescimento espiritual.


Funcionalidades Principais

🔴 1. Tipos de Terço com Orações Gamificadas

Santo Rosário Completo (4 Terços)

  • 20 Mistérios Completos distribuídos em 4 terços distintos:
    • 🌅 Mistérios Gozosos (5 mistérios)
    • 😢 Mistérios Dolorosos (5 mistérios)
    • Mistérios Gloriosos (5 mistérios)
    • 💡 Mistérios Luminosos (5 mistérios)
  • Experiência Completa: 4 sessões de oração para completar todo o Rosário

Terço Mariano Diário (1 Terço por Dia)

  • 5 Mistérios por Sessão conforme o dia da semana:
    • 🗓️ Segunda-feira: Mistérios Gozosos
    • 🗓️ Terça-feira: Mistérios Dolorosos
    • 🗓️ Quarta-feira: Mistérios Gloriosos
    • 🗓️ Quinta-feira: Mistérios Luminosos
    • 🗓️ Sexta-feira: Mistérios Dolorosos
    • 🗓️ Sábado: Mistérios Gozosos
    • 🗓️ Domingo: Mistérios Gloriosos

Outros Tipos de Terço

  • Terço da Misericórdia Divina
  • Terço de São Miguel Arcanjo
  • Terço do Sagrado Coração de Jesus
  • Terço das Santas Chagas
  • Terço de São José

Sistema de Gamificação

  • 🎯 Pontos por Terço: 100 pontos por terço completo
  • 🏆 Conquistas Específicas:
    • "Devoto do Rosário" - Complete os 4 terços (20 mistérios)
    • "Fiel Cotidiano" - Reze o terço diário por 30 dias
    • "Mestre dos Mistérios" - Complete cada tipo 10 vezes
  • 🔥 Streaks Diferenciados:
    • Streak de Terço Diário
    • Streak de Rosário Completo
    • Streak por Tipo de Mistério

🙏 2. Biblioteca de Orações Completa

  • Orações Tradicionais (Pai Nosso, Ave Maria, Credo, Glória)
  • Orações dos Santos (São Francisco, Santo Antônio, São José)
  • Orações por Intenções específicas (Saúde, Trabalho, Família)
  • Novenas Completas para diversos santos
  • Orações Litúrgicas e de Proteção
  • Ladainhas (Ladainha de Nossa Senhora, dos Santos)
  • Sistema de favoritos e personalização

📖 3. Bíblia Católica Completa

  • 73 Livros incluindo deuterocanônicos
  • Leituras Diárias da liturgia
  • Planos de Leitura personalizados
  • Anotações e Destaques pessoais
  • Áudio Bíblia com narração
  • Comentários dos Padres da Igreja
  • Busca Avançada por versículos e temas

4. Missas Regionais

  • Localização de Paróquias com GPS integrado
  • Horários de Missa por região
  • Agenda de Eventos religiosos
  • Informações dos Padres
  • Avaliações da Comunidade
  • Notificações de missas especiais
  • Calendário Litúrgico completo

5. Horários de Confissão

  • Horários por Paróquia atualizados
  • Agendamento Online (onde disponível)
  • Lembretes Personalizados
  • Preparação Espiritual para confissão
  • Mapa de Confessionários próximos

6. Checklist de Confissão

  • Exame de Consciência interativo baseado nos:
    • 10 Mandamentos
    • 7 Pecados Capitais
    • 5 Mandamentos da Igreja
  • Preparação Espiritual guiada
  • Ato de Contrição tradicional
  • Penitência Sugerida
  • Histórico Pessoal privado e seguro

🎮 Sistema de Gamificação Detalhado

Pontuação por Atividade

  • 🔴 Terço Mariano Diário: 100 pontos
  • 🌹 Santo Rosário Completo: 400 pontos (4x100)
  • 🙏 Oração Individual: 25 pontos
  • 📖 Leitura Bíblica Diária: 50 pontos
  • Participação em Missa: 75 pontos
  • 🎯 Confissão: 200 pontos
  • 🔥 Bônus de Streak: +10% por dia consecutivo (máximo +100%)

Níveis de Devoção

  1. 🌱 Iniciante (0-500 pontos) - "Começando a Jornada"
  2. 🙏 Devoto (500-2.000 pontos) - "Crescendo na Fé"
  3. Fiel (2.000-5.000 pontos) - "Perseverando na Oração"
  4. 👑 Servo (5.000-10.000 pontos) - "Servindo a Deus"
  5. Santo (10.000+ pontos) - "Exemplo de Santidade"

Conquistas Especiais

Conquistas do Terço

  • 🌟 "Primeiro Terço" - Complete seu primeiro terço
  • 🌹 "Devoto de Maria" - Complete 30 terços marianos
  • 👑 "Mestre do Rosário" - Complete o Santo Rosário (20 mistérios)
  • 🔥 "Fiel Cotidiano" - Reze por 30 dias consecutivos
  • "Centurião Mariano" - Complete 100 terços
  • 💎 "Cavaleiro de Maria" - Complete 365 terços (1 ano)

Conquistas por Mistério

  • 🌅 "Contemplador da Alegria" - Complete 50 Mistérios Gozosos
  • 😢 "Companheiro do Calvário" - Complete 50 Mistérios Dolorosos
  • "Testemunha da Glória" - Complete 50 Mistérios Gloriosos
  • 💡 "Discípulo da Luz" - Complete 50 Mistérios Luminosos

Conquistas Gerais

  • 📖 "Leitor da Palavra" - Leia um livro completo da Bíblia
  • "Frequentador Fiel" - Participe de 50 missas
  • 🙏 "Penitente Sincero" - Faça sua primeira confissão
  • 👥 "Evangelizador" - Convide 5 amigos para o app

🏗️ Arquitetura Técnica

Frontend

  • Flutter 3.16+ - Framework multiplataforma
  • Dart 3.0+ - Linguagem de programação
  • Material Design 3 - Sistema de design moderno
  • Go Router - Navegação declarativa
  • Riverpod - Gerenciamento de estado reativo

Backend & Serviços

  • Firebase Authentication - Autenticação segura (Email, Google, Facebook)
  • Cloud Firestore - Banco de dados NoSQL em tempo real
  • Firebase Storage - Armazenamento de áudios e imagens
  • Firebase Analytics - Análise de comportamento
  • Firebase Cloud Messaging - Notificações push
  • Google Maps API - Localização de paróquias
  • Local Notifications - Lembretes personalizados

Estrutura do Projeto

lib/
├── main.dart                    # App principal
├── models/                      # Modelos de dados
│   ├── rosary/                  # Modelos do terço
│   │   ├── rosary.dart          # Classes principais do terço
│   │   ├── mystery.dart         # Modelos dos mistérios
│   │   └── prayer_step.dart     # Passos de oração
│   ├── prayers/                 # Modelos de orações
│   ├── bible/                   # Modelos bíblicos
│   ├── masses/                  # Modelos de missas
│   ├── confession/              # Modelos de confissão
│   └── user/                    # Modelos de usuário
├── services/                    # Lógica de negócio
│   ├── auth_service.dart        # Autenticação Firebase
│   ├── rosary_service.dart      # Gerenciamento do terço
│   ├── rosary_firestore_service.dart # Persistência do terço
│   ├── prayer_service.dart      # Orações
│   ├── bible_service.dart       # Bíblia
│   ├── mass_service.dart        # Missas
│   ├── confession_service.dart  # Confissão
│   └── gamification_service.dart# Sistema de gamificação
├── screens/                     # Interfaces de usuário
│   ├── auth/                    # Autenticação
│   │   ├── login_screen.dart    # Tela de login
│   │   └── register_screen.dart # Tela de registro
│   ├── home/                    # Tela principal
│   │   ├── home_screen.dart     # Dashboard principal
│   │   └── profile_screen.dart  # Perfil do usuário
│   ├── rosary/                  # Sistema do terço
│   │   ├── rosary_home_screen.dart     # Tela principal do terço
│   │   └── rosary_tutorial_screen.dart # Tutorial interativo
│   ├── prayers/                 # Orações
│   ├── bible/                   # Bíblia
│   ├── masses/                  # Missas
│   ├── confession/              # Confissão
│   └── splash_screen.dart       # Tela de inicialização
├── widgets/                     # Componentes reutilizáveis
│   ├── common/                  # Widgets comuns
│   │   ├── custom_button.dart   # Botão personalizado
│   │   └── custom_text_field.dart # Campo de texto
│   ├── rosary/                  # Widgets do terço
│   │   └── rosary_icon.dart     # Ícone SVG do rosário
│   ├── bible/                   # Widgets bíblicos
│   └── gamification/            # Widgets de gamificação
└── utils/                       # Utilitários
    ├── app_colors.dart          # Cores católicas
    ├── app_theme.dart           # Temas claro/escuro
    ├── routes.dart              # Configuração de rotas
    └── constants.dart           # Constantes globais

🚀 Roadmap de Desenvolvimento

✅ Fase 1 - MVP (Concluída)

  • Autenticação Firebase completa (Email + Google)
  • Sistema de Terço Gamificado com 20 mistérios
  • Orações Tradicionais autênticas
  • Interface Católica responsiva
  • Sistema de Pontuação e conquistas básicas
  • Navegação Moderna com Go Router
  • Persistência Firebase de dados

📖 Fase 2 - Expansão (Em Desenvolvimento)

  • Bíblia Católica Completa com 73 livros
  • Missas Regionais com GPS e horários
  • Sistema de Confissão completo
  • Gamificação Avançada com níveis e rankings
  • Mais Tipos de Terço (Misericórdia, São Miguel)
  • Áudio das Orações com narração

👥 Fase 3 - Comunidade (Planejada)

  • Grupos de Oração virtuais
  • Pedidos de Oração comunitários
  • Desafios Mensais de devoção
  • Ranking Global de devotos
  • Compartilhamento de reflexões
  • Notificações Inteligentes

💎 Fase 4 - Premium (Futura)

  • Biblioteca de Áudios premium
  • Direção Espiritual com IA
  • Conteúdo Exclusivo de santos
  • Análises Espirituais detalhadas
  • Modo Offline completo
  • API Pública para desenvolvedores

🎨 Design e Experiência

Design Católico Autêntico

  • Cores Litúrgicas:
    • 🟣 Roxo (Quaresma/Advento)
    • 🟡 Dourado (Celebrações)
    • ⚪ Branco (Pureza)
    • 🟢 Verde (Tempo Comum)
    • 🔴 Vermelho (Mártires/Pentecostes)
  • Iconografia Sagrada: Rosários SVG, cruzes, símbolos marianos
  • Typography Reverente: Fontes legíveis e contemplativas
  • Animações Suaves: Transições que inspiram devoção
  • Modo Noturno: Interface escura para oração contemplativa

Experiência Gamificada

  • Feedback Visual imediato nas orações
  • Progresso Animado durante o terço
  • Celebrações de conquistas
  • Streaks Motivacionais com efeitos visuais
  • Níveis de Devoção com badges únicos

Acessibilidade Católica

  • Fonte Ajustável para todas as idades (jovens a idosos)
  • Alto Contraste para deficientes visuais
  • Narração Completa de todas as orações
  • Navegação Simples para usuários menos familiarizados com tecnologia
  • Suporte Multilíngue (Português, Latim planejado)

💰 Modelo de Monetização (estimado, não sei ainda)

Planos de Assinatura

  • 🆓 Católico Básico: Recursos fundamentais gratuitos

    • Terço mariano diário
    • Orações básicas tradicionais
    • Sistema de gamificação simples
    • Bíblia com livros principais
  • 💎 Católico Premium: R$ 9,99/mês ou R$ 89,99/ano

    • Santo Rosário completo (20 mistérios)
    • Biblioteca completa de orações
    • Áudio profissional de todas as orações
    • Bíblia católica completa (73 livros)
    • Comentários dos Padres da Igreja
    • Estatísticas avançadas de devoção
    • Temas exclusivos litúrgicos
  • 👨‍👩‍👧‍👦 Família Católica: R$ 149,99/ano (até 6 usuários)

    • Todos os recursos Premium
    • Desafios familiares de oração
    • Compartilhamento de intenções
    • Controle parental
    • Relatórios familiares de devoção

Recursos Premium Detalhados

  • 🎵 Áudio Premium: Orações narradas por padres
  • 📚 Biblioteca Expandida: +200 orações de santos
  • 🤖 Assistente Espiritual: IA para orientação
  • 📊 Analytics Espirituais: Insights sobre sua jornada
  • 🎨 Temas Litúrgicos: Visual adaptado às estações
  • ☁️ Backup Premium: Sincronização em múltiplos dispositivos
  • 📱 App Web: Acesso completo via navegador
  • 🔔 Notificações Inteligentes: Horários personalizados de oração

🛠️ Instalação e Desenvolvimento

Pré-requisitos Técnicos

  • Flutter SDK 3.16+
  • Dart SDK 3.0+
  • Firebase CLI mais recente
  • Android Studio / VS Code com extensões Flutter
  • Git para controle de versão
  • Node.js 16+ (para Firebase tools)

Configuração do Ambiente

  1. Clone o repositório
git clone https://github.com/usuario/katholiks.git
cd katholiks
  1. Instale as dependências
flutter pub get
  1. Configure o Firebase
# Instalar FlutterFire CLI
dart pub global activate flutterfire_cli

# Configurar projeto Firebase
flutterfire configure --project=katholiks-9152a
  1. Configure variáveis de ambiente
# Crie o arquivo .env na raiz do projeto
echo "GOOGLE_MAPS_API_KEY=sua_chave_aqui" > .env
  1. Execute o projeto
# Desenvolvimento
flutter run

# Release
flutter run --release

Configuração Firebase Detalhada

Firestore Database Structure

users/{userId}/
├── profile/
│   ├── name: string
│   ├── email: string
│   ├── photoURL: string
│   ├── createdAt: timestamp
│   └── preferences: object
├── rosary_stats/
│   ├── totalRosariesCompleted: number
│   ├── currentStreak: number
│   ├── longestStreak: number
│   ├── totalPrayerTime: duration
│   ├── mysteriesCompleted: map
│   ├── dailyGoals: map
│   ├── totalAchievements: number
│   ├── totalPoints: number
│   └── averageSessionDuration: number
├── rosary_sessions/
│   └── {sessionId}/
│       ├── mysteryType: string
│       ├── mysteries: array
│       ├── startTime: timestamp
│       ├── endTime: timestamp
│       ├── completedPrayers: number
│       ├── totalPrayers: number
│       └── isCompleted: boolean
├── achievements/
│   └── {achievementId}/
│       ├── id: string
│       ├── title: string
│       ├── description: string
│       ├── points: number
│       ├── unlockedAt: timestamp
│       └── category: string
└── prayer_history/
    └── {date}/
        ├── prayers: array
        ├── totalTime: duration
        └── points: number

parishes/{parishId}/
├── name: string
├── address: object
├── location: geopoint
├── phone: string
├── website: string
├── masses/
│   └── {dayOfWeek}/
│       └── times: array
├── confessions/
│   └── {dayOfWeek}/
│       └── schedule: object
└── events/
    └── {eventId}/
        ├── title: string
        ├── description: string
        ├── date: timestamp
        └── type: string

Firebase Security Rules

rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {
    // Usuários podem ler/escrever apenas seus próprios dados
    match /users/{userId} {
      allow read, write: if request.auth != null && request.auth.uid == userId;
    }
    
    // Paróquias são públicas para leitura
    match /parishes/{parishId} {
      allow read: if true;
      allow write: if request.auth != null && request.auth.token.admin == true;
    }
  }
}

🧪 Testes e Qualidade

Estrutura de Testes

test/
├── unit/                        # Testes unitários
│   ├── models/
│   ├── services/
│   └── utils/
├── widget/                      # Testes de widgets
│   ├── screens/
│   └── widgets/
├── integration/                 # Testes de integração
│   ├── auth_flow_test.dart
│   ├── rosary_flow_test.dart
│   └── firebase_integration_test.dart
└── mocks/                       # Mocks para testes
    ├── mock_auth_service.dart
    └── mock_firestore.dart

Comandos de Teste

# Executar todos os testes
flutter test

# Testes com coverage
flutter test --coverage

# Testes de integração
flutter drive --target=test_driver/app.dart

📊 Métricas e Analytics

KPIs Principais

  • Retenção de Usuários: % que voltam após 1, 7, 30 dias
  • Engajamento de Oração: Terços completados por usuário
  • Conversão Premium: Taxa de upgrade para planos pagos
  • Tempo de Sessão: Duração média das orações
  • Streak Médio: Sequência média de dias orando

Analytics Implementados

  • Firebase Analytics: Comportamento de usuários
  • Custom Events: Ações específicas do app (terço iniciado, completado)
  • Crashlytics: Monitoramento de crashes
  • Performance Monitoring: Tempos de carregamento

🤝 Contribuição

Como Contribuir

  1. Fork o projeto
  2. Clone seu fork localmente
  3. Crie uma branch para sua feature (git checkout -b feature/NovaFuncionalidade)
  4. Implemente sua mudança seguindo os padrões
  5. Teste completamente sua implementação
  6. Commit suas mudanças (git commit -m 'Adiciona nova funcionalidade')
  7. Push para sua branch (git push origin feature/NovaFuncionalidade)
  8. Abra um Pull Request detalhado

Padrões de Código

  • Dart Style Guide: Seguir convenções oficiais
  • Nomenclatura Clara: Nomes descritivos em português/inglês
  • Documentação: Comentar código complexo
  • Testes: Cobertura mínima de 80%
  • Commits Semânticos: Usar conventional commits

Áreas Prioritárias para Contribuição

  • 📱 Mobile: Melhorias na interface
  • 🔧 Backend: Otimizações no Firebase
  • 🎨 Design: Novos temas e animações
  • 🌐 Localização: Tradução para outros idiomas
  • Acessibilidade: Melhorias para inclusão
  • 📖 Conteúdo: Novas orações e reflexões

📝 Licença e Legal

Licença MIT

Este projeto está licenciado sob a Licença MIT - veja o arquivo LICENSE.md para detalhes completos.

Direitos Autorais Religiosos

  • Orações Tradicionais: Domínio público da Igreja Católica
  • Textos Bíblicos: Tradução CNBB (com permissão)
  • Reflexões: Baseadas nos ensinamentos dos Santos e Papas
  • Imagens: Royalty-free ou criação própria

Política de Privacidade

  • Dados Mínimos: Coletamos apenas o necessário
  • Criptografia: Todos os dados são criptografados
  • Anonimização: Analytics sem identificação pessoal
  • Conformidade LGPD: Totalmente aderente à legislação brasileira

🙏 Agradecimentos Especiais

Inspirações Espirituais

  • Papa Francisco por incentivar a evangelização digital
  • São João Paulo II patrono da juventude católica
  • Santa Teresa de Calcutá exemplo de service e tecnologia
  • São Josemaría Escrivá por ensinar a santificar o trabalho

Comunidade Técnica

  • Flutter Team pelo framework excepcional
  • Firebase Team pela infraestrutura robusta
  • Material Design pelo sistema de design
  • Open Source Community pelas bibliotecas utilizadas

Colaboradores Católicos

  • Padres Consultores que validaram o conteúdo religioso
  • Comunidades Paroquiais que testaram o aplicativo
  • Beta Testers devotos que nos ajudaram a melhorar
  • Designers Católicos que contribuíram com arte sacra

📈 Status do Projeto

Versão Atual: 1.0.0-beta

Estado: Em desenvolvimento ativo

Plataformas: Android e iOS

Idiomas: Português brasileiro (Latim planejado)

Próximos Milestones

  • 🎯 v1.0.0 (Março 2026): Launch público
  • 📖 v1.1.0 (Maio 2026): Bíblia completa
  • v1.2.0 (Julho 2026): Missas regionais
  • 👥 v2.0.0 (Setembro 2026): Recursos sociais

Desenvolvido com 🙏 para a maior glória de Deus

"Tudo o que fizerdes, fazei-o de coração, como para o Senhor"
Colossenses 3:23


Se este projeto te ajuda em sua jornada espiritual, considere dar uma estrela!

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors