|
|
🚀 Quickstart
|
|
|
:rocket: Quickstart
|
|
|
|
|
|
Guia rápido para rodar o projeto em ambiente local.
|
|
|
📋Pré-requisitos
|
|
|
Guia rápido para rodar o projeto em ambiente local. :clipboard:Pré-requisitos
|
|
|
|
|
|
Antes de começar, certifique-se de ter instalado:
|
|
|
|
|
|
Docker (com Docker Desktop ou equivalente rodando)
|
|
|
Java JDK 21
|
|
|
Node.js
|
|
|
pnpm
|
|
|
```plaintext
|
|
|
Docker (com Docker Desktop ou equivalente rodando)
|
|
|
Java JDK 21
|
|
|
Node.js
|
|
|
pnpm
|
|
|
```
|
|
|
|
|
|
Será necessário abrir 3 terminais diferentes.
|
|
|
📦 Terminal 1: Banco de Dados (Docker)
|
|
|
Será necessário abrir 3 terminais diferentes. :package: Terminal 1: Banco de Dados (Docker)
|
|
|
|
|
|
cd backend
|
|
|
docker compose build # Necessário apenas na primeira vez ou caso sejam feitas alterações
|
|
|
docker compose up
|
|
|
cd backend docker compose build # Necessário apenas na primeira vez ou caso sejam feitas alterações docker compose up
|
|
|
|
|
|
Para remover todos os dados do banco e começar do zero (não deve ser necessário, mas é bom saber):
|
|
|
|
|
|
docker compose down -v # Apaga todos os dados
|
|
|
|
|
|
🔧 Terminal 2: Backend
|
|
|
Pré-requisitos:
|
|
|
:wrench: Terminal 2: Backend Pré-requisitos:
|
|
|
|
|
|
Java JDK 21 instalado
|
|
|
Verifique com:
|
|
|
```plaintext
|
|
|
Java JDK 21 instalado
|
|
|
Verifique com:
|
|
|
|
|
|
java -version
|
|
|
# Deve aparecer algo como:
|
|
|
# java version "22.0.2" 2024-07-16
|
|
|
# Java(TM) SE Runtime Environment (build 22.0.2+9-70)
|
|
|
# Java HotSpot(TM) 64-Bit Server VM (build 22.0.2+9-70, mixed mode, sharing)
|
|
|
java -version
|
|
|
# Deve aparecer algo como:
|
|
|
# java version "22.0.2" 2024-07-16
|
|
|
# Java(TM) SE Runtime Environment (build 22.0.2+9-70)
|
|
|
# Java HotSpot(TM) 64-Bit Server VM (build 22.0.2+9-70, mixed mode, sharing)
|
|
|
```
|
|
|
|
|
|
Passos:
|
|
|
🐧Linux:
|
|
|
Passos: :penguin:Linux:
|
|
|
|
|
|
cd backend
|
|
|
chmod +x ./mvnw # ou chmod +x mvn
|
|
|
./mvnw spring-boot:run # em alguns casos pode ser "mvn spring-boot:run"
|
|
|
cd backend chmod +x ./mvnw # ou chmod +x mvn ./mvnw spring-boot:run # em alguns casos pode ser "mvn spring-boot:run"
|
|
|
|
|
|
🪟 Windows:
|
|
|
|
|
|
cd backend
|
|
|
.\mvnw.cmd spring-boot:run # em alguns casos pode ser "mvn spring-boot:run"
|
|
|
cd backend .\\mvnw.cmd spring-boot:run # em alguns casos pode ser "mvn spring-boot:run"
|
|
|
|
|
|
💻 Terminal 3: Frontend
|
|
|
Pré-requisitos:
|
|
|
:computer: Terminal 3: Frontend Pré-requisitos:
|
|
|
|
|
|
Node.js instalado
|
|
|
```plaintext
|
|
|
Node.js instalado
|
|
|
|
|
|
pnpm instalado
|
|
|
pnpm instalado
|
|
|
|
|
|
Verifique com:
|
|
|
Verifique com:
|
|
|
|
|
|
node -v
|
|
|
# Deve aparecer algo como:
|
|
|
# v22.14.0
|
|
|
pnpm -v
|
|
|
# Deve aparecer algo como:
|
|
|
# 10.15.1
|
|
|
node -v
|
|
|
# Deve aparecer algo como:
|
|
|
# v22.14.0
|
|
|
pnpm -v
|
|
|
# Deve aparecer algo como:
|
|
|
# 10.15.1
|
|
|
```
|
|
|
|
|
|
Passos:
|
|
|
|
|
|
cd web
|
|
|
pnpm install
|
|
|
pnpm dev
|
|
|
|
|
|
🛠 Estrutura do Projeto
|
|
|
cd web pnpm install pnpm dev
|
|
|
|
|
|
/
|
|
|
├── backend/ # Código do backend
|
|
|
├── docs/ # Documentação
|
|
|
└── web/ # Código do frontend
|
|
|
:tools: Estrutura do Projeto
|
|
|
|
|
|
/ \
|
|
|
├── backend/ # Código do backend ├── docs/ # Documentação \
|
|
|
└── web/ # Código do frontend |
|
|
\ No newline at end of file |