douglas-morais / edu-conecte

Software to contribute as a solution to part of the problems of education - DoWhile2021 - ForBrasil Challenge

  

EDU Conecte

🕮 Aproximando os pais no acompanhamento escolar dos filhos

💻 Desafio DoWhile2021 - FortBrasil / Parceria Rocketseat 🚀

Sumário

• Sumário
• Descrição
  • 🔥 Desafio
  • 💡 Solução
    • Introdução
    • Atacando parte do Problema
    • Resolução
    • Esquemático geral
    • Mapeamento dos processos
      • Detalhamento de fluxo
      • Subprocessos - Cadastrar filho
      • Subprocesso - Redigir notificação
• Status da Aplicação
• Instalação
• Iniciando servidor
  • Clone da Aplicação
  • Container banco de dados MySQL com Adminer
  • Servidor da Aplicação
• Testes
• Documentação da API
• Licença de uso

Descrição

🔥 Desafio

"Pensando em construir o futuro, como você solucionaria os problemas de acesso à educação hoje, utilizando a tecnologia?"

💡 Solução

Introdução

Os problemas com a educação brasileira já são reconhecidos de décadas. Poucos avanços são notados quando leva em consideração a classe mais pobre, aquela que depende diretamente dos serviços públicos.
Do desinteresse na grade curricular à falta de acompanhamento dos pais, da formação dos professores à falta de infraestrutura, sofremos desde problemas culturais à falta de atenção do governo.

Atacando parte do Problema

A rotina diária dos pais por vezes não ajuda o acompanhamento dos filhos nas atividades solicitadas pelas escolas. Pensando em construir o futuro, minha ideia é contribuir com parte da solução, facilitando para os pais um acompanhamento pós aula diariamente mais eficiente.

Resolução

Essa solução tecnológica implenta de forma mais simples possível uma comunicação direta do professor para com os pais dos alunos que leciona. O professor poderá ao final de cada aula regitrar notificações no EDU Conecte(sistema) selecionando a turma, série e categoria da notificação que automaticamente após registrado o sistema notificará os pais por email.
Exemplo:
-- Notificação do professor de matemática: "Dever de casa, livro Saber matemática pág. 56, exercicios." | Prazo final: 10/3/2022.

Esquemático geral

Mapeamento dos processos

Para melhor visualização clicar na imagem ou fazer o download da mesma.

Detalhamento de fluxo

Subprocessos - Cadastrar filho

Subprocesso - Redigir notificação

Status da Aplicação

🚧 Novas funcionalidades 🚀 em construção... 🚧
O desenvolvimento avança nas seguintes etapas:

1. Funcionalidade
2. Teste Manual
3. Testes Unitários

O desenvolvimento dos testes End-To-End será codificado após Fluxo dos processos desenvolvidos.

Instalação

  $ npm install

Iniciando servidor

Clone da Aplicação

# Download do projeto
$ git clone https://github.com/Douglas-Morais/edu-conecte.git

# Entrando na página do projeto
$ cd edu-conecte

# Abra com o editor de sua preferência (ex. VSCode)
$ code .

Container banco de dados MySQL com Adminer

# Subindo os Containers da aplicação
$ docker-compose up -d

MySQL https://localhost:3306

Adminer https://localhost:8080

Servidor da Aplicação

  # development
  $ npm run start

  # watch mode - hot reload
  $ npm run start:dev

  # production mode
  $ npm run start:prod

Testes

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Documentação da API

Documentação disponível após o start do servidor

http://localhost:3000/docs/

Licença de uso

MIT.