Teste SchoolSystem

Projeto Backend - Sistema de Gestão Escolar

Descrição: Com o encerramento da pandemia, as escolas e universidades necessitarão de um controle eficiente na alocação de salas para professores e alunos. Para atender a essa demanda, desenvolvi uma API em Node.js utilizando o framework AdonisJS (https://adonisjs.com).

Tecnologias utilizadas no projeto:

• Back-end : AdonisJs
• Banco de dados : Mysql
• Infraestrutura/Contêineres : Docker

Instalação do projeto

• Este projeto foi construido em imagens Docker, é necessário ter o Docker instalado em sua máquina previamente.

Passo 1

Após clonar o projeto em sua máquina navegue até o diretório raiz do projeto:

  cd schoolsystem

Passo 2

Execute o seguinte comando para buildar o projeto:

  docker compose up -d --build

Passo 3

Após o build acesse o container da Api:

docker exec -it schoolSystem sh

Passo 4

E agora realize as migrations para a criação de tabelas no banco de dados:

node ace migration:run

Passo 5

E finalmente utilize o comando de seed para popular seu banco de dados:

node ace db:seed

Pronto!

Seu projeto estará rodando no seguinte endereço:

  http://localhost:3333/

Uso do Swagger

Após iniciar o projeto, você pode explorar e interagir com a API usando a interface do Swagger. Acesse aqui para obter mais detalhes sobre as rotas disponíveis.

Arquivo Insomnia_routes.json

Na raiz do projeto, você encontrará um arquivo chamado "Insomnia_routes.json". Para importar as rotas no Insomnia, siga as seguintes etapas:

• Abra o Insomnia.
• No menu suspenso do nome do Documento ou Coleção, selecione Importar/Exportar.
• Escolha uma opção no menu suspenso Importar Dados.
• Selecione o arquivo "Insomnia_routes.json" e importe.

Agora você terá todas as rotas disponíveis no Insomnia para facilitar o teste e a interação com a API.

Acessos

• logar como professor:
  email: professor1@example.com
  password: senha123

• logar como estudante:
  email: student2@example.com
  password: senha456