diff --git a/README.md b/README.md new file mode 100644 index 0000000..2f705c4 --- /dev/null +++ b/README.md @@ -0,0 +1,70 @@ +# Game List - Listagem e Manipulação de jogos (Java™ - Spring Boot) +[Game List - Listagem de jogos com manipulação dos jogos da lista] - Desenvolvimento do backEnd -> Java + Spring Boot + +## Antes de começar! +Para iniciarmos o projeto é necessário preparar o nosso ambiente Spring. Pensando na praticidade, o projeto foi **desenvolvido/executado/testado** utilizando o software 'Visual Studio Code' e suas extensões. + +## 1- Preparação do ambiente **[VS Code]** +No 'Visual Studio Code' será **necessária à instalação de quatro extensões**, sendo elas: + +* ### 1.1 - Spring Boot Dashboard (disponível em Visual Studio Marketplace) + ![Spring Boot Dashboard](https://github.com/GabrielTorelo/BackEnd_Game_List-Java_Spring/assets/57268681/8f4ee0be-8225-4b62-b152-d2b08a470bf4) + +* ### 1.2 - Spring Boot Extension Pack (disponível em Visual Studio Marketplace) + ![Spring Boot Extension Pack](https://github.com/GabrielTorelo/BackEnd_Game_List-Java_Spring/assets/57268681/f9ea52ee-c337-4858-b56b-4d57021a08e1) + +* ### 1.3 - Spring Boot Tools (disponível em Visual Studio Marketplace) + ![Spring Boot Tools](https://github.com/GabrielTorelo/BackEnd_Game_List-Java_Spring/assets/57268681/f0c9229f-dea0-47b1-86a7-f7bb18ad137d) + +* ### 1.4 - Spring Initializr Java Support (disponível em Visual Studio Marketplace) + ![Spring Initializr Java Support](https://github.com/GabrielTorelo/BackEnd_Game_List-Java_Spring/assets/57268681/415fb3e5-242e-4cae-81d4-124325c57c69) + +## 2 - Instalação + +Clone o projeto usando: +```bash +git clone https://github.com/GabrielTorelo/BackEnd_Game_List-Java_Spring.git +``` + +Vá até o diretório do projeto: +```bash +cd BackEnd_Game_List-Java_Spring +``` + +Abra o projeto no 'Visual Studio Code': +```bash +code . +``` + +## 3 - Execução +Temos duas formas de iniciarmos o projeto. + +* ### 3.1 - Utilizando o 'Spring Boot Dashboard' [Recomendado] + ![image](https://github.com/GabrielTorelo/BackEnd_Game_List-Java_Spring/assets/57268681/c31f03f6-89d8-4bef-a8db-83c57b826c20) + + ![image](https://github.com/GabrielTorelo/BackEnd_Game_List-Java_Spring/assets/57268681/86d9bf0f-1dae-4078-a114-f142f00d1e55) + + ### **ou** + +* ### 3.2 - Utilizando o 'Run and Debug' + ![image](https://github.com/GabrielTorelo/BackEnd_Game_List-Java_Spring/assets/57268681/62706de5-4ccb-49f2-8215-bf7be0166352) + + #### OBS: Independentemente do método escolhido, um comando será executado no terminal do 'Visual Studio Code', ao "término da execução", aparecerá uma mensagem no terminal: **'Started GameListApplication in X seconds'**, indicando que o projeto foi iniciado com sucesso! + +## 🛠 Dependências e Plugins Usados + +| Nome | Versão | +| :-------------------------------- | :------- | +| **Dependências** || +| 🔵 Spring Boot - Starter Data JPA | `3.0.6` | +| 🔵 Spring Boot - Starter Web | `3.0.6` | +| 🔵 H2 Database Engine | `2.2.22` | +| 🔵 PostgreSQL JDBC Driver | `42.6.0` | +| 🔵 Spring Boot Starter Test | `3.0.6` | +| **Plugins** || +| 🔴 Apache Maven Resources Plugin | `3.1.0` | +| 🔴 Spring Boot Maven Plugin | `3.0.6` | + +## 🔗 Links +[![GitHub]( https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white)](https://github.com/GabrielTorelo/FrontEnd_Game_List-TypeScript_React) +[![Postman](https://img.shields.io/badge/Postman-FF6C37?style=for-the-badge&logo=postman&logoColor=white)](https://documenter.getpostman.com/view/22314470/2s946h7rv1) \ No newline at end of file