Documentação Aluminify
Aluminify é uma plataforma educacional white-label open-source focada na experiência do aluno. Esta documentação cobre a arquitetura, deployment e desenvolvimento da plataforma.
Quickstart
Coloque seu curso no ar em poucos minutos com Docker.
Arquitetura
Entenda o padrão de módulos funcionais e route groups.
Arquitetura Modular
O projeto segue uma arquitetura estrita de Módulos Funcionais dentro de Route Groups do Next.js. Isso garante isolamento de contexto, escalabilidade e facilidade de manutenção.
Estrutura Interna de um Módulo
Cada módulo segue rigorosamente este padrão:
- (aluno)/
Rotas e páginas visíveis para o aluno.
- (gestao)/
Área administrativa (Professores e Staff).
- components/
Componentes de UI isolados do módulo.
- services/
Lógica de negócio e acesso a dados.
Módulos Funcionais
Curso
Gestão acadêmica completa: Segmentos, Disciplinas, Frentes, Módulos e Conteúdos.
Usuário
Gestão de Alunos, Professores e Staff, incluindo matrículas e permissões.
Empresa
Configurações do Tenant, personalização white-label e integrações.
Sala de Estudos
Ambiente de execução do aluno: Player de aulas, atividades e progresso.
Instalação
O método recomendado para desenvolvimento e produção é via Docker.
git clone https://github.com/SinesysTech/aluminify.git
# Entre na pasta
cd aluminify-core
# Configure ambiente
cp .env.example .env.local
# Inicie com Docker
docker-compose up -d
API Reference
A API foi reestruturada para espelhar a organização dos módulos, utilizando rotas em português e hierárquicas.
| Módulo | Rota Base | Descrição |
|---|---|---|
| Usuário | /api/usuario | Alunos, Professores, Perfil |
| Curso | /api/curso | Estrutura curricular completa |
| Empresa | /api/empresa | Configurações do Tenant |
| Sala de Estudos | /api/sala-de-estudos | Atividades e Progresso |