Edulign é uma plataforma educacional abrangente projetada para alinhar experiências de aprendizagem em múltiplos contextos com foco principal no enade, nosso objetivo é facilitar o desenvolvimento acadêmico e profissional dos usuários.
- Democratizar o acesso à educação de qualidade
- Personalizar experiências de aprendizagem
- Conectar alunos, professores e instituições
- Otimizar o processo educacional através de tecnologia
- Node.js (v18 ou superior)
- npm ou yarn
- Banco de dados PostgreSQL (para Prisma)
- Conta Supabase (para armazenamento)
# Clone o repositório
git clone git@github.com:tiagodlb/Edulign.git
cd edulign/back
# Instale as dependências
npm install
# Configure as variáveis de ambiente
cp .env.example .env
# Edite o arquivo .env com suas configurações
# Configure o banco de dados
npx prisma migrate dev
# Popule o banco de dados
npm run seed
# Inicie o servidor de desenvolvimento
npm run dev# Navegue até o diretório do frontend
cd ../front
# Instale as dependências
npm install
# Inicie o servidor de desenvolvimento
npm run dev- Backend: http://localhost:3000/api
- Frontend: http://localhost:3001
- Documentação API: http://localhost:3000/api-docs
- Framework: Express.js
- Banco de Dados: PostgreSQL com ORM Prisma
- Autenticação: JWT com bcrypt
- Documentação API: Swagger
- Armazenamento: Supabase
- Geração de PDF: pdf-lib
- Integração com IA: API OpenAI
- Segurança: Helmet, Express Rate Limit
- Logs: Morgan
- Framework: Next.js (com Turbopack)
- Componentes UI: Radix UI
- Estilização: Tailwind CSS
- Gerenciamento de Formulários: React Hook Form com validação Zod
- Gerenciamento de Estado: Zustand
- Cliente API: Axios, TanStack Query
- Autenticação: NextAuth.js
- Temas: next-themes
- Geração de PDF: jsPDF com AutoTable
- Integração com IA: OpenAI e AI SDK
npm run dev: Inicia o servidor de desenvolvimento com reinício automáticonpm run seed: Popula o banco de dados com dados iniciaisnpm run test: Executa os testes (não implementado)
npm run dev: Inicia o servidor de desenvolvimento com Turbopacknpm run build: Compila para produçãonpm run start: Inicia o servidor de produçãonpm run lint: Executa o ESLint para verificação de código
- Clone o repositório
- Crie uma branch para sua feature (
git checkout -b feature/nome-da-feature) - Desenvolva as alterações necessárias
- Execute os testes locais
- Faça commit das alterações (
git commit -m 'Adiciona nova feature') - Faça push para a branch (
git push origin feature/nome-da-feature) - Abra um Pull Request
- Daniel Duarte - Desenvolvedor Full-stack
- Tiago de Lima - Desenvolvedor Full-stack
- Yasmin Mendes - Desenvolvedor Full-stack
- Lucas Emanoel Amaral - Desenvolvedor Full-stack
- Arlindo Macieira - Desenvolvedor Full-stack
Este projeto foi desenvolvido como parte da disciplina PROJETO E DESENVOLVIMENTO DE SOFTWARE, sob orientação do Professor Dr. THALES LEVI AZEVEDO VALENTE, durante o semestre letivo 2024.2 no curso de Engenharia da Computação da Universidade Federal do Maranhão (UFMA).
Este projeto está licenciado sob a Licença MIT - veja os detalhes abaixo.
@autor: Daniel Duarte, Tiago de Lima, Yasmin Mendes, Lucas Emanoel Amaral, Arlindo Macieira @contato: [tigolimab223@gmail.com] @data última versão: 21/02/2025 @versão: 1.0 @outros repositórios: [URLs - apontem para os seus Gits, se quiserem] @Agradecimentos: Universidade Federal do Maranhão (UFMA), Professor Doutor Thales Levi Azevedo Valente, e colegas de curso.
Este material é resultado de um trabalho acadêmico para a disciplina PROJETO E DESENVOLVIMENTO DE SOFTWARE, sob a orientação do professor Dr. THALES LEVI AZEVEDO VALENTE, semestre letivo 2024.2, curso Engenharia da Computação, na Universidade Federal do Maranhão (UFMA). Todo o material sob esta licença é software livre: pode ser usado para fins acadêmicos e comerciais sem nenhum custo. Não há papelada, nem royalties, nem restrições de "copyleft" do tipo GNU. Ele é licenciado sob os termos da Licença MIT, conforme descrito abaixo, e, portanto, é compatível com a GPL e também se qualifica como software de código aberto. É de domínio público. Os detalhes legais estão abaixo. O espírito desta licença é que você é livre para usar este material para qualquer finalidade, sem nenhum custo. O único requisito é que, se você usá-los, nos dê crédito.
Licenciado sob a Licença MIT. Permissão é concedida, gratuitamente, a qualquer pessoa que obtenha uma cópia deste software e dos arquivos de documentação associados (o "Software"), para lidar no Software sem restrição, incluindo sem limitação os direitos de usar, copiar, modificar, mesclar, publicar, distribuir, sublicenciar e/ou vender cópias do Software, e permitir pessoas a quem o Software é fornecido a fazê-lo, sujeito às seguintes condições:
Este aviso de direitos autorais e este aviso de permissão devem ser incluídos em todas as cópias ou partes substanciais do Software.
O SOFTWARE É FORNECIDO "COMO ESTÁ", SEM GARANTIA DE QUALQUER TIPO, EXPRESSA OU IMPLÍCITA, INCLUINDO MAS NÃO SE LIMITANDO ÀS GARANTIAS DE COMERCIALIZAÇÃO, ADEQUAÇÃO A UM DETERMINADO FIM E NÃO INFRINGÊNCIA. EM NENHUM CASO OS AUTORES OU DETENTORES DE DIREITOS AUTORAIS SERÃO RESPONSÁVEIS POR QUALQUER RECLAMAÇÃO, DANOS OU OUTRA RESPONSABILIDADE, SEJA EM AÇÃO DE CONTRATO, TORT OU OUTRA FORMA, DECORRENTE DE, FORA DE OU EM CONEXÃO COM O SOFTWARE OU O USO OU OUTRAS NEGOCIAÇÕES NO SOFTWARE.
Para mais informações sobre a Licença MIT: https://opensource.org/licenses/MIT.
Última atualização: 21 de fevereiro de 2025