Skip to content

Commit b63a27f

Browse files
docs(development): Update README.md
1 parent 0454fcb commit b63a27f

File tree

1 file changed

+49
-47
lines changed

1 file changed

+49
-47
lines changed

README.md

Lines changed: 49 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,25 @@
1-
# Spring Boot API
1+
# 🚀 Spring Boot API (Branch: Development)
22

3-
## Descrição
4-
Este projeto é uma API de autenticação desenvolvida com **Spring Boot** e **Spring Security**, utilizando **H2** como banco de dados em ambiente de desenvolvimento (**DSV**). A API fornece funcionalidades de **registro** e **login** de usuários e será consumida por um frontend desenvolvido em outro framework.
3+
## 📌 Descrição
4+
Este projeto é uma API de **autenticação** desenvolvida com **Spring Boot** e **Spring Security**, utilizando **H2** como banco de dados em ambiente de desenvolvimento (**DSV**). A API fornece funcionalidades de **registro** e **login** de usuários e será consumida por um frontend desenvolvido em outro framework.
55

6-
## Tecnologias Utilizadas
7-
- **Java 17**
8-
- **Spring Boot 3**
9-
- **Spring Security**
10-
- **Spring Data JPA**
11-
- **H2 Database** (Apenas para DSV)
12-
- **JWT (JSON Web Token)**
13-
- **Maven**
6+
**📌 Esta documentação refere-se à branch `development` do projeto.**
147

15-
## Requisitos
8+
## 🛠️ Tecnologias Utilizadas
9+
-**Java 17**
10+
- 🌱 **Spring Boot 3**
11+
- 🔐 **Spring Security**
12+
- 🗄️ **Spring Data JPA**
13+
- 🛢️ **H2 Database** (Apenas para DSV)
14+
- 🔑 **JWT (JSON Web Token)**
15+
- 🏗️ **Maven**
16+
17+
## 📋 Requisitos
1618
Antes de rodar o projeto, certifique-se de ter instalado:
17-
- **Java 17** ou superior
18-
- **Maven** configurado
19+
- **Java 17** ou superior
20+
- **Maven** configurado
1921

20-
## Configuração do Banco de Dados no Ambiente DSV
22+
## 🛢️ Configuração do Banco de Dados no Ambiente DSV
2123
No ambiente de desenvolvimento (**DSV**), utilizamos o banco de dados **H2** em memória. Ele é um banco leve, embutido e ideal para testes. O `application.properties` está configurado da seguinte forma:
2224

2325
```properties
@@ -37,38 +39,38 @@ spring.h2.console.path=/h2
3739
spring.jpa.defer-datasource-initialization=true
3840
```
3941

40-
### Explicação do `application.properties`
41-
- `spring.datasource.url`: Define a URL de conexão do banco H2 em memória.
42-
- `spring.datasource.driver-class-name`: Define o driver JDBC do H2.
43-
- `spring.datasource.username` e `spring.datasource.password`: Credenciais padrão do H2.
44-
- `spring.jpa.database-platform`: Define o dialeto do Hibernate para H2.
45-
- `spring.jpa.hibernate.ddl-auto=update`: Permite que o Hibernate atualize automaticamente o esquema do banco de dados.
46-
- `spring.jpa.show-sql=true`: Exibe no console as consultas SQL executadas.
47-
- `spring.h2.console.path=/h2`: Habilita o console web do H2, acessível em `http://localhost:8080/h2`.
48-
- `spring.jpa.defer-datasource-initialization=true`: Garante que as configurações do banco sejam carregadas corretamente.
49-
50-
## Credenciais **Spring Security** 🦺🔐:
51-
- **Usuário**: `admin`
52-
- **Senha**: `123`
53-
54-
## Como Rodar o Projeto
55-
1. Clone o repositório:
42+
### ℹ️ Explicação do `application.properties`
43+
- 🔗 `spring.datasource.url`: Define a URL de conexão do banco H2 em memória.
44+
- 🚗 `spring.datasource.driver-class-name`: Define o driver JDBC do H2.
45+
- 🔐 `spring.datasource.username` e `spring.datasource.password`: Credenciais padrão do H2.
46+
- 🔄 `spring.jpa.database-platform`: Define o dialeto do Hibernate para H2.
47+
- 📌 `spring.jpa.hibernate.ddl-auto=update`: Permite que o Hibernate atualize automaticamente o esquema do banco de dados.
48+
- 📊 `spring.jpa.show-sql=true`: Exibe no console as consultas SQL executadas.
49+
- 🌐 `spring.h2.console.path=/h2`: Habilita o console web do H2, acessível em `http://localhost:8080/h2`.
50+
- `spring.jpa.defer-datasource-initialization=true`: Garante que as configurações do banco sejam carregadas corretamente.
51+
52+
## 🔐 Credenciais **Spring Security**
53+
- 👤 **Usuário**: `admin`
54+
- 🔑 **Senha**: `123`
55+
56+
## ▶️ Como Rodar o Projeto
57+
1. 📥 Clone o repositório:
5658
```sh
5759
git clone https://github.com/VavaHelper/Vava-API.git
5860
```
59-
2. Acesse o diretório do projeto:
61+
2. 📂 Acesse o diretório do projeto:
6062
```sh
6163
cd Vava-API
6264
```
63-
3. Troque para a branch DSV:
65+
3. 🔀 Troque para a branch DSV:
6466
```sh
6567
git checkout development
6668
```
67-
4. Compile e execute o projeto:
69+
4. 🏗️ Compile e execute o projeto:
6870
```sh
6971
mvn spring-boot:run
7072
```
71-
5. Para acessar o console do H2, abra o navegador e digite:
73+
5. 🌍 Para acessar o console do H2, abra o navegador e digite:
7274
```
7375
http://localhost:8080/h2
7476
```
@@ -77,11 +79,11 @@ spring.jpa.defer-datasource-initialization=true
7779
- **Usuário**: `sa`
7880
- **Senha**: `123`
7981

80-
## Endpoints Disponíveis
82+
## 📡 Endpoints Disponíveis
8183
A API oferece os seguintes endpoints:
8284

83-
### Registro de Usuário
84-
- **POST** `/api/auth/register`
85+
### 📝 Registro de Usuário
86+
- **POST** `/auth/register`
8587
- **Request Body:**
8688
```json
8789
{
@@ -91,8 +93,8 @@ A API oferece os seguintes endpoints:
9193
}
9294
```
9395

94-
### Login de Usuário
95-
- **POST** `/api/auth/login`
96+
### 🔑 Login de Usuário
97+
- **POST** `/auth/login`
9698
- **Request Body:**
9799
```json
98100
{
@@ -107,12 +109,12 @@ A API oferece os seguintes endpoints:
107109
}
108110
```
109111

110-
## Futuras Implementações
111-
- Recuperação de senha
112-
- Perfis de usuários (Admin, Usuário Comum)
113-
- Integração com OAuth2
114-
- Atendimento/Suporte ao Usuário Cliente
112+
## 🔮 Futuras Implementações
113+
- 🔄 Recuperação de senha
114+
- 🏅 Perfis de usuários (Admin, Usuário Comum)
115+
- 🔗 Integração com OAuth2
116+
- 🎧 Atendimento/Suporte ao Usuário Cliente
115117

116-
## Licença
117-
Este projeto está sob a licença MIT. Sinta-se à vontade para utilizá-lo e modificá-lo.
118+
## 📜 Licença
119+
Este projeto está sob a licença MIT. Sinta-se à vontade para utilizá-lo e modificá-lo.
118120

0 commit comments

Comments
 (0)