Projeto Grupo 4 - Turma JavaScript 10

📇 Path Educ

API NestJS para gestão de estudantes e bolsas

👥 Equipe de Desenvolvimento

Este projeto foi desenvolvido pela equipe Grupo 4 da Turma JavaScript 10:

• Bruno Pinheiro de Carvalho - Membro
• Gabrieli Martins - Membro
• Kauã Gabriel de Farias - Membro
• Assis Pires Neto - Membro
• LiA - Membro
• Patrícia Souza - Membro
• Pedro - Membro

📝 Descrição

O Path Educ é uma API construída com NestJS para gerenciamento de estudantes interessados em cursos e das bolsas de estudo disponíveis. O objetivo é oferecer uma base sólida para cadastro, consulta, atualização e vinculação de estudantes às bolsas, com integração a banco de dados relacional e boas práticas de desenvolvimento.

🎯 Objetivos do Projeto

• Centralizar o cadastro e gestão de estudantes
• Gerenciar bolsas de estudo com regras de validade e status
• Permitir o vínculo entre estudantes e bolsas
• Disponibilizar endpoints simples e organizados (CRUD)

📦 Entidades e Atributos

Entidade: Bolsa

• id: Identificador único da bolsa
• nome: Nome da bolsa
• porcentagem: Percentual de desconto aplicado
• instituicao: Instituição responsável pela bolsa
• curso: Curso específico (opcional)
• validade: Data de validade da bolsa
• ativa: Indicador se a bolsa está ativa
• estudante: Lista de estudantes vinculados (relacionamento)

Entidade: Estudante

• id: Identificador único do estudante
• nome: Nome completo
• email: E-mail válido
• endereco: Endereço do estudante
• idade: Idade
• cursoInteresse: Curso de interesse
• ativo: Indicador se o cadastro está ativo
• bolsa: Bolsa vinculada (relacionamento)

✨ Funcionalidades Principais (CRUD)

• ✅ Create - Criar Registros: Inserir novos estudantes e bolsas
• 📋 Read - Listar Registros: Consultar estudantes e bolsas disponíveis
• 🔍 Read - Buscar por ID: Visualizar detalhes de um estudante/bolsa específico
• 🔄 Update - Atualizar Registros: Modificar dados de estudantes e bolsas
• ❌ Delete - Remover Registros: Excluir estudantes e bolsas

✨ Funcionalidades Extra

• Atualização de Status: Atualizar status do bolsista/estudante (ativo ou inativo)

🚀 Tecnologias Utilizadas

Back-end

• NestJS - Framework progressivo para Node.js
• Node.js - Ambiente de execução JavaScript
• TypeScript - Linguagem de programação tipada

Banco de Dados

• MySQL - Sistema de gerenciamento de banco de dados relacional
• TypeORM - ORM para modelagem e consultas

Ferramentas de Desenvolvimento

• Insomnia ou Postman - Clientes API para testes
• VSCode - IDE
• Git - Controle de versão
• GitHub - Hospedagem de código
• Trello - Organização e gestão de tarefas

📦 Instalação

# Instalar dependências
npm install

🔧 Executando a Aplicação

# Modo desenvolvimento
npm run start

# Modo desenvolvimento com watch (reinicia automaticamente)
npm run start:dev

# Modo desenvolvimento com .env
npm run start:env

# Modo debug
npm run start:debug

# Modo produção (após build)
npm run build
npm run start:prod

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

🧪 Executando os Testes

# Testes unitários
npm run test

# Testes em watch
npm run test:watch

# Testes e2e (end-to-end)
npm run test:e2e

# Cobertura de testes
npm run test:cov

📁 Estrutura do Projeto

src/
├── app.module.ts           # Módulo raiz da aplicação
├── main.ts                 # Ponto de entrada da aplicação
├── bolsa/
│   ├── bolsa.module.ts     # Módulo de bolsas
│   ├── controllers/
│   │   └── bolsa.controllers.ts  # Controller de bolsas
│   ├── services/
│   │   └── bolsa.service.ts      # Service de bolsas
│   └── entities/
│       └── bolsa.entity.ts  # Entidade Bolsa (TypeORM)
└── estudante/
    ├── estudante.module.ts  # Módulo de estudantes
    ├── controllers/
    │   └── estudante.controller.ts   # Controller de estudantes
    ├── services/
    │   └── estudante.services.ts     # Service de estudantes
    └── entities/
        └── estudante.entity.ts       # Entidade Estudante (TypeORM)

🌐 Deploy

Para fazer o deploy da aplicação NestJS em produção, consulte a documentação oficial de deployment.

Deploy com Mau (AWS)

npm install -g @nestjs/mau
mau deploy

📚 Recursos e Documentação

• Documentação do NestJS
• Discord da Comunidade NestJS
• Cursos Oficiais NestJS
• NestJS Devtools

🤝 Contribuindo

Este é um projeto colaborativo da turma. Para contribuir:

1. Faça um fork do projeto
2. Crie uma branch para sua feature (git checkout -b feature/NovaFeature)
3. Commit suas mudanças (git commit -m 'Adiciona nova feature')
4. Push para a branch (git push origin feature/NovaFeature)
5. Abra um Pull Request

📄 Licença

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

---

Desenvolvido com ❤️ pela equipe Grupo 4 - Turma JavaScript 10