ic045-sistemaacademico-2023 / backend-sistema-academico-ic-ufba

Sistema Acadêmico para o IC UFBA

Componente Curricular

IC045: Tópicos em Sistemas de Informação e Web I

Drive

Requisitos

Modelagem do banco de dados

Protótipo

Documento de Arquitetura de Software

Plano de Teste

Documento de Implantação/Instalação

Aplicação

Aplicação	Link
Frontend	https://ic045-siag.netlify.app
Backend	https://learning-ufba-sistemaacademico.ue.r.appspot.com/api/v1
Swagger	https://learning-ufba-sistemaacademico.ue.r.appspot.com/api/v1/swagger-ui.html

Tecnologias

1. Java
2. SpringBoot
3. JPA

Time de Desenvolvimento

Nome	Cargo
Karen Botelho	Gerente do Projeto e desenvolvedor
Gustavo Mendel	Vice Gerente do Projeto e desenvolvedor
Elis Marcela	Desenvolvedor
Glauber	Desenvolvedor
Lávio	Desenvolvedor
Vitor de Jesus	Desenvolvedor
Lucas Natanael	Desenvolvedor
Adiel Cristo	Desenvolvedor
Cleiton Rocha	Desenvolvedor
Matheus	Desenvolvedor

Desenvolvimento

Instalação do projeto (em Windows)

1. Instale o Git
2. Instale o Eclipse
3. Clone o repositório da nuvem para a sua máquina local
4. Importe o projeto Maven no Eclipse pela opção Existing Maven Project
5. Aguarde o Eclipse terminar de realizar os downloads necessários para a importação
6. Instale JDK 17 ou superior
7. Instale Lombok 7.1. Siga os passos

Configuração do banco de dados

1. Copie o arquivo .env.properties.dist para .env.properties.
2. Descomente a seção correspondente ao banco de dados que será usado (H2 ou MySQL).

H2

1. Altere a propriedade spring.sql.init.mode para always para executar os scripts src/main/resources/schema.sql e src/main/resources/data.sql sempre que iniciar a aplicação.
2. Para habilitar o console e acessar o banco de dados, altere a propriedade spring.h2.console.enabled para true no arquivo src/main/resources/application.properties.
3. Acesse o console no endereço http://localhost:8080/api/v1/h2-console.

MySQL

1. Instale o MySQL Workbench.
2. Adicione uma conexão no MySQL Workbench e configure as credenciais de acesso.
3. Reinicie seu computador ou siga os passos dessa thread para concluir a configuração.
4. Execute os scripts src/main/resources/schema.sql e src/main/resources/data.sql para a criação do banco de dados usando o Workbench ou o MySQL Client:
   1. Workbench:
      1. Abra o MySQL Shell do Workbench e execute \sql para converter a linguagem do shell de JS para SQL.
      2. Execute \connect root@localhost no MySQL Shell do Workbench pra conectar ao banco, então coloque a senha do root e pressione pra concluir.
      3. Localize os scripts src/main/resources/schema.sql e src/main/resources/data.sql e execute o comando \source <caminho-do-arquivo> no terminal do MySQL. Provavelmente os caminhos serão algo como <caminho-do-repositorio>\src\main\resources\schema.sql e <caminho-do-repositorio>\src\main\resources\data.sql
   2. MySQL Client:
      1. Execute o comando mysql -u root -p e digite a senha do seu MySQL.
      2. Localize os scripts src/main/resources/schema.sql e src/main/resources/data.sql e execute o comando source <caminho-do-arquivo> no terminal do MySQL. Provavelmente os caminhos serão algo como <caminho-do-repositorio>\src\main\resources\schema.sql e <caminho-do-repositorio>\src\main\resources\data.sql

Execução da aplicação

1. Clique em Run As, e então em Java Application da classe SistemaAcademicoApplication em <caminho-do-repositorio>\src\main\java\com\ic045\sistemaacademico
2. Consulte os endpoints da API através da URL http://localhost:8080/api/v1/swagger-ui/index.html