Skip to content

Latest commit

 

History

History
65 lines (42 loc) · 1.9 KB

CONTRIBUTING.md

File metadata and controls

65 lines (42 loc) · 1.9 KB

Contributing to the Project

Local Development Environment Setup

Prerequisites

Ensure you have the following tools installed:

  • Docker Desktop - For running the PostgreSQL database
  • Java 21 JDK - For the backend Quarkus application
  • Node.js - For frontend development (version 22 or higher)
  • pnpm - For frontend package management
  • Python 3.13 - For local development scripts
  • pre-commit - For automatic code formatting

Initial Setup

Run the setup script to prepare your development environment:

./local_setup.py

This script will:

  • Install required pre-commit hooks
  • Install frontend Node dependencies
  • Generate a local RSA key pair for JWT authentication

Development Workflow

Starting the Development Environment

Run a single command to start the entire stack in development mode:

./dev_local.py

This script automatically:

  • Launches the PostgreSQL database in Docker
  • Starts the Quarkus backend in development mode
  • Runs the frontend Vite development server
  • Gracefully shuts down all components when interrupted

Accessing the Application

Once the development environment is running, you can access the application via:

Building for Production

To build the entire application for production, run the following command:

cd app && ./gradlew build

This creates a runnable JAR file in app/build/quarkus-app/ directory.

The resulting JAR is packaged in a container image in the docker-compose.prod.yml file created in the Github release workflow ( see .github/workflows/release.yml)