todosimple-api

🔖 Sobre

Curso de programação para apoio da disciplina Trabalho Interdisciplinar Aplicações para Processos de Negócios do 2º período de Engenharia de Software, PucMinas Praça da Liberdade 2022/2.

Neste curso é abordado como criar uma API Restful utilizando o framework Spring Boot da linguagem Java. Conteúdo inclui vídeo aulas de explicações teóricas, instalação de ferramentas, prática focada no código e como consumir a API pelo Postman. Além disso, é apresentado como criar uma simples interface web em HTML, CSS e JavaScript (também com a biblioteca Booststrap) que consume esta API.

Esta é uma simples aplicação onde usuário podem se cadastrar e registrarem tarefas para sua conta.

---

👨‍💻 Monitor

• Lucas Ângelo Oliveira Martins Rocha

---

👩‍🏫 Professor responsável

• Hugo Bastos De Paula

---

🚀 Tecnologias

• Frontend:
  • HTML 5
  • CSS 3
  • JavaScript
  • Bootstrap 5
• Backend:
  • Java 17
  • Apache Maven >=3.8.6
• Database:
  • MySQL Server
• Ferramenta
  • Visual Studio Code (VSCode)
  • Postman
  • Git
  • Docker

---

⤵ Instruções de utilização

Essas instruções vão te levar a uma cópia do projeto rodando em sua máquina local para propósitos de testes, desenvolvimento e aprendizagem.

Pré-requisitos:

• Ter instalado todas as ferramentas e dependências ensinadas no vídeo Aula 02 - Instalação de todas as ferramentas e configuração de ambiente
  • Java
  • Maven
  • MySQL
  • Docker (Docker-Compose)

• Passo 1: Clonar o repositório:

  $ git clone https://github.com/ICEI-PUC-Minas-PPLES-TI/PLF-ES-2022-2-MON-CursoAPIJava.git
  

• Passo 2: Configurar e iniciar a API Spring Boot (backend)

  • Passo 2.1: Entrar no arquivo application.properties:

  $ vi PLF-ES-2022-2-MON-CursoAPIJava\src\main\resources\application-dev.properties
  

  • Passo 2.2: Configurar as credenciais de banco de dados de acordo com sua instalação do MySQL Server:

  # Database config
  spring.datasource.url=jdbc:mysql://localhost:3306/todosimple?createDatabaseIfNotExist=true
  spring.datasource.username=root
  spring.datasource.password=root
  

  • Passo 2.3: Voltar para a pasta raíz do projeto:

  $ cd PLF-ES-2022-2-MON-CursoAPIJava\
  

  • Passo 2.4: Iniciar a aplicação Spring Boot:

  $ mvn clean install
  

  • Passo 2.4.1: Iniciar a aplicação Spring Boot utilizando o Maven:

  $ mvn spring-boot:run
  

  ou

  • Passo 2.4.1: Iniciar a aplicação utilizando Docker-Compose:

  $ docker-compose up
  

  • API estará rodando em http://localhost:8080/

• Passo 3: Entrar na aplicação frontend após subir a API

  • Passo 3.1: Entrar na pasta raíz do projeto:

  $ cd PLF-ES-2022-2-MON-CursoAPIJava\
  

  • Passo 3.2: Abrir o arquivo index.html diretamente ou pela extensão Live Server do VsCode:

  $ cd PLF-ES-2022-2-MON-CursoAPIJava\view\login.html
  

  • Frontend estará rodando em http://127.0.0.1:5500/view/login.html caso iniciado com Live Server.

---

🔗 Links do projeto

• Playlist do Youtube com vídeos do curso
• Slide de apresentação
• Documento de ferramentas e configuração de ambiente

---

📝 Licença

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

---