Using

Prerequisites

To use bugzkit ensure you have the following software installed:

Initialize Your Project

Go to a bugzkit repo , click on a Use this template button (you need to be logged in on github for this button to appear). Once you created your repo, clone it and run the initialization script:


./init.sh

The script will:

Ask for your project name.
Replace all instances of bugzkit with your project name.
Remove unnecessary files and folders, including the script itself.
Ask if you want to keep the docs or not.

Once completed, commit the changes and start coding!

Running the Backend

Running Locally

For the API to start properly, you’ll need Postgres and Redis running. The easiest way to do that is via the docker-compose-infra.dev.yml file in the backend/spring-boot directory:


docker-compose -f docker-compose-infra.dev.yml up -d

After the services are up and running, navigate to the backend/spring-boot directory and start the application:


cd backend/spring-boot
./mvnw spring-boot:run -Dspring-boot.run.profiles=dev

Alternatively, use IntelliJ IDEA. A pre-configured run configuration is available - just click and run!

Running via Docker

For running the API using Docker, execute:


docker-compose -f docker-compose-api.dev.yml up --build -d

Note: SMTP and Google OAuth require configuration. Refer to the Environment Variables section for setup.

Running the Frontend

Ensure the API is up and running before starting the UI. Then, create a .env file in the frontend/svelte-kit directory with the following content:


# Public
PUBLIC_APP_NAME=your_app_name
PUBLIC_API_URL=http://localhost:8080
# Private
JWT_SECRET=secret

To start the UI, navigate to the frontend/svelte-kit directory and run:


cd frontend/svelte-kit
pnpm install
pnpm run dev

You’re all set!

Regenerating Frontend Models

Frontend TypeScript models are auto-generated from the backend OpenAPI spec. Whenever you make changes to backend DTOs or endpoints, regenerate the models by running the backend first, then:


cd frontend/svelte-kit
pnpm run generate:models

This fetches the live spec from http://localhost:8080/v3/api-docs and updates src/lib/models/api.d.ts.