Plataforma de Gestão Escolar

1. Visão Geral do Projeto

Sistema web para gestão integrada de escolas, alunos, processos e relatórios da Secretaria Municipal de Educação (SME).

Módulos Principais

• Gestão de Alunos: Cadastro, matrícula e histórico
• Gestão de Escolas: Cadastro, status e localização
• Processos: Reclamações com anexos e protocolo
• Relatórios: Desempenho acadêmico e orçamento
• Dashboard: Indicadores em tempo real

2. Telas do Sistema

>Login

Tela de autenticação com e-mail, senha e recuperação. Protegida por JWT.

Endpoint: POST /api/auth/login

Dashboard

Painel com indicadores: número de escolas, alunos, orçamento disponível e notificações pendentes.

Endpoint: GET /api/dashboard (autenticado)

Cadastro de Aluno

Formulário com validação de CPF, data de nascimento, escola e série.

Endpoint: POST /api/alunos

Listagem de Escolas

Tabela com filtros por bairro, região e status (ativa/inativa).

Endpoint: GET /api/escolas?bairro=Centro

Abertura de Reclamação

Formulário com categoria, descrição e upload de fotos/documentos.

Endpoint: POST /api/processos/reclamacoes

3. Documentação da API (OpenAPI)

API RESTful com autenticação JWT. Estrutura compatível com Swagger.

openapi: 3.0.3
info:
  title: Plataforma de Gestão Escolar - API
  version: 1.0.0
servers:
  - url: https://api.sme-plataforma.gov.br
security:
  - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
paths:
  /api/auth/login:
    post:
      summary: Autenticar usuário
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required: [email, password]
              properties:
                email: { type: string, format: email }
                password: { type: string }
      responses:
        '200':
          description: Login bem-sucedido
          content:
            application/json:
              schema:
                type: object
                properties:
                  token: { type: string }
        '401':
          description: Credenciais inválidas
  /api/alunos:
    post:
      summary: Cadastrar aluno
      security:
        - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required: [nome, cpf, escola_id]
              properties:
                nome: { type: string }
                cpf: { type: string }
                data_nascimento: { type: string, format: date }
                escola_id: { type: integer }
      responses:
        '201':
          description: Aluno criado com sucesso

4. Cronograma do Projeto

Desenvolvimento em 6 sprints ágeis + fase de homologação.

5. Plano de Sprints (Scrum)

6. Arquitetura Técnica

Frontend

React.js, HTML5, CSS3, JavaScript, Axios, Chart.js

Backend

Node.js + Express, PostgreSQL, Sequelize, JWT

Infraestrutura

Deploy: AWS / Vercel / Google Cloud

7. Entregas Finais

• Protótipos interativos
• Documentação OpenAPI
• Código fonte (frontend + backend)
• Ambiente de testes online
• Manual do usuário