Getting Started

Jump to bottom

Ângelo Azevedo edited this page May 28, 2025 · 1 revision

Getting Started

Prerequisites

Java 17+
Docker & Docker Compose
Node.js (v18+) & npm (for the website)

Backend (API)

Go to the api directory:
```
cd api
```
Build and run the backend:
```
./gradlew bootRun
```

Database

Start the database using Docker Compose:
```
docker-compose up -d
```

Frontend (Website)

Go to the website directory:
```
cd website
```
Install dependencies:
```
npm install
```
Run the development server:
```
npm run dev
```

Access

API: http://localhost:8080
Website: http://localhost:3000

Using Docker

You can use Docker Compose to start all required services (such as the database) easily:

docker-compose up -d

This command should be run from the project root. It will start all services defined in docker-compose.yml in the background.

Using start.sh

The start.sh script automates the bootstrap process, starting backend, frontend, and Docker services as needed:

./start.sh

If you get a permission error, make the script executable first:

chmod +x start.sh