Skip to content

Plataforma web moderna para estudos baseada em flashcards que utiliza o algoritmo de repetição espaçada SM-2

License

Notifications You must be signed in to change notification settings

bernardopg/mvp-estetoscopio

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

37 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

🎴 MVP Estetoscópio

Sistema de Flashcards com Repetição Espaçada

Plataforma moderna de estudos inspirada no Anki, construída com Next.js 16, TypeScript e SQLite. Crie baralhos personalizados com texto, imagens e áudio, e estude de forma inteligente com algoritmo SM-2.

Next.js TypeScript Tailwind CSS License

✨ Demo📚 Documentação🚀 Início Rápido🤝 Contribuir


📖 Sobre o Projeto

O MVP Estetoscópio é uma plataforma web moderna para estudos baseada em flashcards que utiliza o algoritmo de repetição espaçada SM-2 para otimizar a retenção de conhecimento. O sistema calcula automaticamente os melhores intervalos para revisar cada card, maximizando o aprendizado com o mínimo de tempo.

Além do sistema de flashcards tradicional, o Estetoscópio oferece comunidades para compartilhamento de decks, sistema de pastas e tags para organização, notificações inteligentes e uma interface moderna e responsiva com suporte completo a dark mode.

💡 Por que usar repetição espaçada?

A repetição espaçada é uma técnica de aprendizado baseada em revisar informações em intervalos crescentes de tempo. Estudos mostram que essa técnica pode aumentar a retenção de longo prazo em até 200% comparado a métodos tradicionais de estudo.

✨ Principais Funcionalidades

🎴 Flashcards Multimídia

  • Texto com Markdown
  • Imagens (JPEG, PNG, GIF)
  • Áudio (MP3, WAV, OGG)
  • Animação 3D de flip

🧠 Repetição Espaçada

  • Algoritmo SM-2
  • Intervalos automáticos
  • 4 níveis de dificuldade
  • Tracking de progresso

📊 Organização

  • Sistema de pastas
  • Tags com cores
  • Ícones personalizados
  • Favoritos e filtros

🌐 Comunidades

  • Compartilhar decks
  • Comentários
  • Notificações
  • Clonar baralhos

🚀 Início Rápido

Pré-requisitos

  • Node.js 18+
  • npm, yarn ou pnpm

Instalação

# 1. Clone o repositório
git clone https://github.com/bernardopg/mvp-estetoscopio.git
cd mvp-estetoscopio

# 2. Instale as dependências
npm install

# 3. Inicie o servidor de desenvolvimento
npm run dev

Acesse http://localhost:3000 🎉

Primeiros Passos

  1. 📝 Crie sua conta em /signup
  2. 🔐 Faça login em /login
  3. ➕ Crie seu primeiro baralho
  4. 📚 Comece a estudar!

🎨 Demonstração

Nota: Screenshots serão adicionados em breve em .github/assets/screenshots/

Interface Principal

Arquitetura do Sistema

graph TB
    subgraph Frontend
        A[Next.js 16 App Router]
        B[React Components]
        C[Tailwind CSS]
    end

    subgraph Backend
        D[API Routes]
        E[Authentication JWT]
        F[Spaced Repetition SM-2]
    end

    subgraph Database
        G[SQLite better-sqlite3]
        H[Prepared Statements]
    end

    subgraph Storage
        I[Local File System]
        J[public/uploads/]
    end

    A --> B
    B --> C
    A --> D
    D --> E
    D --> F
    D --> G
    G --> H
    D --> I
    I --> J

    style A fill:#000,stroke:#fff,color:#fff
    style G fill:#003B57,color:#fff
    style E fill:#6366f1,color:#fff
    style F fill:#8b5cf6,color:#fff
Loading

🛠️ Stack Tecnológica

Next.js
Next.js 16
Framework React
TypeScript
TypeScript 5
Type Safety
Tailwind
Tailwind CSS 4
Styling
SQLite
SQLite
Database

Detalhes completos: Veja a arquitetura técnica na Wiki


📚 Documentação

Toda a documentação detalhada está disponível na Wiki do Projeto:

📖 Para Usuários

💻 Para Desenvolvedores

🔧 Para Mantenedores


🗺️ Roadmap

v1.1.0 (Atual) ✅

  • Sistema de autenticação completo (JWT + cookies)
  • CRUD de baralhos e flashcards
  • Sistema de repetição espaçada (algoritmo SM-2)
  • Upload de mídia (imagens e áudio)
  • Dashboard com estatísticas
  • Sistema de pastas e organização
  • Tags personalizadas com cores
  • Sistema de comunidades
  • Compartilhamento de decks
  • Comentários em decks compartilhados
  • Sistema de notificações
  • Configurações de notificações
  • Documentação MDX interativa
  • Sidebar collapsable e responsiva
  • UI/UX moderna e polida
  • Dark mode completo
  • Responsividade mobile

v1.2.0 (Em Desenvolvimento) 🚧

  • Export/Import de baralhos (Anki .apkg)
  • Estatísticas avançadas com gráficos (Charts.js/Recharts)
  • PWA (Progressive Web App) para uso offline
  • Sistema de busca global
  • Filtros avançados de baralhos
  • Modo de estudo personalizado
  • Suporte a LaTeX para fórmulas matemáticas

v2.0 (Planejado) 🔮

  • App mobile nativo (React Native)
  • Sincronização multi-dispositivo (Firebase/Supabase)
  • Sistema de conquistas e gamificação
  • Editor WYSIWYG para cards
  • Temas personalizados
  • API pública para integrações
  • Plugin system para extensões

Veja o roadmap completo: CHANGELOG.md


🤝 Contribuindo

Contribuições são bem-vindas!

  1. Fork o projeto
  2. Crie uma branch (git checkout -b feature/MinhaFeature)
  3. Commit suas mudanças (git commit -m 'feat: adicionar MinhaFeature')
  4. Push para a branch (git push origin feature/MinhaFeature)
  5. Abra um Pull Request

Leia o guia completo: CONTRIBUTING.md

🐛 Reportar Bugs

Abra uma issue usando o template de bug report.

✨ Sugerir Features

Abra uma issue usando o template de feature request.


📄 Licença

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


🙏 Agradecimentos


📞 Contato

Bernardo Gomes


⬆ Voltar ao topo

Desenvolvido com ❤️ e ☕ por Bernardo Gomes

⭐ Se este projeto te ajudou, considere dar uma estrela!

GitHub stars GitHub forks

About

Plataforma web moderna para estudos baseada em flashcards que utiliza o algoritmo de repetição espaçada SM-2

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Sponsor this project

Contributors 3

  •  
  •  
  •