Ouroboros

O Ouroboros é uma aplicação completa para planejamento de estudos, projetada para ajudar estudantes a organizar seus horários, acompanhar o progresso e gerenciar revisões de forma eficaz.

📖 Sumário

• 🎥 Demonstração em Vídeo
• ✨ Funcionalidades
• 🚀 Tecnologias Utilizadas
• 🏁 Como Começar
  • Pré-requisitos
  • Instalação
  • Executando a Aplicação
    • Modo de Desenvolvimento
    • Modo de Produção com Docker
    • Executando com Imagem Pré-construída do Docker Hub
    • Construindo e Executando a Versão Desktop (Electron)
• 🤝 Contribuição
• 📄 Licença
• 📞 Contato

🎥 Demonstração em Vídeo

Assista a uma breve introdução da aplicação e suas funcionalidades no vídeo abaixo:

➡️ Assistir à introdução no YouTube

Confira também o tutorial completo para aprender a usar todas as ferramentas:

➡️ Tutorial Completo no YouTube

📥 Download

A versão mais recente da aplicação para desktop (Windows e Linux) pode ser baixada aqui:

➡️ Baixar Ouroboros v1.1.3

💖 Apoie o Projeto

Se o Ouroboros te ajudou nos seus estudos, considere apoiar o projeto com uma doação! Sua contribuição ajuda a manter o desenvolvimento contínuo, a implementação de novas funcionalidades e a correção de bugs. O projeto visa ajudar estudantes hipossuficientes a ter acesso a uma ferramenta de estudos poderosa, visando democratizar o estudo. Qualquer valor é muito bem-vindo e faz uma grande diferença.

Você pode doar escaneando o QR Code abaixo com seu aplicativo de banco:

Muito obrigado pelo seu apoio!

✨ Funcionalidades

• Planejamento de Estudos por Ciclos: Crie e gerencie ciclos de estudo com base em editais ou objetivos específicos.
• Registro de Sessões: Registre sessões de estudo para diferentes matérias, monitorando o tempo e o conteúdo estudado.
• Estatísticas de Desempenho: Visualize sua distribuição de estudos e desempenho com gráficos dinâmicos (progresso semanal, horas por matéria, etc.).
• Gerenciamento de Revisões: Agende e acompanhe revisões para garantir a retenção do conteúdo a longo prazo.
• Acompanhamento de Simulados: Registre os resultados dos simulados para monitorar sua evolução.
• Cronômetro Integrado: Utilize um cronômetro para marcar o tempo de estudo com precisão.
• Matérias e Tópicos Personalizáveis: Adicione suas próprias matérias e tópicos para adaptar o planejador às suas necessidades.
• Modo Claro e Escuro: Alterne entre temas para uma visualização mais confortável.
• Interface com Drag-and-Drop: Reordene e gerencie facilmente seus itens de estudo.

🚀 Tecnologias Utilizadas

• Framework: Next.js
• Linguagem: TypeScript
• Estilização: Tailwind CSS
• Componentes de UI: Radix UI & Ícones Lucide
• Visualização de Dados: Chart.js
• Drag & Drop: dnd-kit
• Gerenciamento de Datas: date-fns
• Containerização: Docker

🏁 Como Começar

Siga estas instruções para obter uma cópia do projeto e executá-lo em sua máquina local.

Pré-requisitos

• Node.js (versão 20.x ou superior recomendada)
• npm
• Docker e Docker Compose

Instalação

1. Clone o repositório:

   git clone https://github.com/grebsu/Ouroboros.git

2. Navegue até o diretório do projeto:

   cd Ouroboros

3. Instale as dependências:

   npm install

Executando a Aplicação

Modo de Desenvolvimento

Para iniciar o servidor de desenvolvimento:

npm run dev

Abra http://localhost:3000 no seu navegador para ver o resultado.

Modo de Produção com Docker

Para executar a aplicação em um contêiner Docker, garantindo um ambiente de produção consistente:

1. Construa a imagem Docker:

   docker compose build

2. Inicie a aplicação:

   docker compose up -d

   A aplicação estará disponível em http://localhost:3000.

Executando com Imagem Pré-construída do Docker Hub

Para executar a aplicação usando a imagem pré-construída do Docker Hub:

1. Puxe a imagem Docker:

   docker pull ouroboros73/ouroboros:latest

2. Execute o contêiner Docker: Certifique-se de configurar suas variáveis de ambiente (por exemplo, DATABASE_URL, NEXTAUTH_SECRET, NEXTAUTH_URL) ao executar o contêiner. Você pode passá-las usando a flag -e.

   docker run -p 3000:3000 -e DATABASE_URL="your_database_url" -e NEXTAUTH_SECRET="your_nextauth_secret" -e NEXTAUTH_URL="http://localhost:3000" ouroboros73/ouroboros:latest

Construindo e Executando a Versão Desktop (Electron)

Para construir e executar a aplicação como um aplicativo de desktop (Linux, Windows) usando Electron, siga os passos abaixo. Certifique-se de que todas as dependências gerais do projeto já foram instaladas com npm install.

1. Configuração Inicial: Este comando prepara o ambiente e pode ser necessário para garantir que tudo funcione corretamente.

   npm run setup

2. Executar em Modo de Desenvolvimento: Para iniciar o aplicativo Electron em modo de desenvolvimento com hot-reload.

   npm run dev:electron

3. Construir para Produção: Para gerar os pacotes de instalação para produção (ex: .deb, .AppImage para Linux; .exe para Windows).

   npm run build:electron

   Os arquivos finais serão gerados na pasta dist/.

🤝 Contribuição

Contribuições são muito bem-vindas! Se você tiver ideias, sugestões ou quiser reportar um bug, por favor, abra uma issue ou envie um pull request.

📄 Licença

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

📞 Contato

Para dúvidas ou suporte, entre em contato com Grebsu.