Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/ierinconc/billar-pro-backend/llms.txt

Use this file to discover all available pages before exploring further.

This guide walks you from zero to a running Billar Pro Backend instance on your local machine. You will need Java 21, Maven (or use the included mvnw wrapper), and Docker with Docker Compose installed. The whole process takes under five minutes.
1

Clone the repository

Download the source code from GitHub:
git clone https://github.com/ierinconc/billar-pro-backend.git
cd billar-pro-backend
2

Start PostgreSQL with Docker

The repository ships a docker-compose.yml that starts a PostgreSQL 16 container named billarpro-postgres. It maps the container’s port 5432 to host port 5433 and creates the billardb database automatically.
docker-compose up -d
Verify the container is healthy:
docker ps
You should see billarpro-postgres with a status of Up. The database is now reachable at localhost:5433.
3

Configure the application

Copy the provided example configuration to create your local application.yml:
cp src/main/resources/application-example.yml src/main/resources/application.yml
Open src/main/resources/application.yml and set the datasource password to match the one in docker-compose.yml:
spring:
  datasource:
    url: jdbc:postgresql://localhost:5433/billardb
    username: postgres
    password: YOUR_PASSWORD
    driver-class-name: org.postgresql.Driver
  jpa:
    hibernate:
      ddl-auto: update
    show-sql: true
    properties:
      hibernate:
        dialect: org.hibernate.dialect.PostgreSQLDialect

server:
  port: 8080
The example file uses port 5432 in the JDBC URL, but the Docker Compose setup maps the container to host port 5433. Make sure to use jdbc:postgresql://localhost:5433/billardb in your local application.yml.
Alternatively, you can copy .env.example to .env and supply credentials as environment variables for a Docker-based deployment:
cp .env.example .env
# Edit .env with your chosen passwords
4

Build and run

Use the Maven wrapper to compile and start the server:
./mvnw spring-boot:run
On Windows, use:
mvnw.cmd spring-boot:run
Watch the startup logs. The DataSeeder will automatically create 6 tables and the admin user the first time the application connects to an empty database:
Mesas creadas exitosamente
Usuario admin creado exitosamente
The API is ready when you see a log line confirming Tomcat started on port 8080.
5

Make your first API call

Authenticate with the default admin credentials to receive a JWT token:
curl -s -X POST http://localhost:8080/api/auth/login \
  -H "Content-Type: application/json" \
  -d '{"username": "admin", "password": "billar123"}'
The response body is the JWT token string:
eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbiIsImlhdCI6...
Copy the token — you will use it as a bearer credential for every subsequent request.

​
Using the JWT Token

Pass the token in the Authorization header to access any protected endpoint. For example, retrieve the list of all billiard tables: 
curl -s http://localhost:8080/api/mesas \
  -H "Authorization: Bearer <your-token-here>"
Replace <your-token-here> with the full token string returned by the login call. A successful response returns a JSON array of Mesa objects, each showing the table number, state, and price per hour.
JWT tokens issued by Billar Pro Backend expire after 10 hours. After expiry, repeat the POST /api/auth/login call to obtain a fresh token. There is no refresh-token mechanism; re-authentication is required.
The default password billar123 is seeded for local development only. Change it before deploying to any shared or public environment. A compromised admin account gives full access to all session, product, and consumption data.

Build docs developers (and LLMs) love

Get started for freeTalk to us