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 easies way to that is via docker-compose-db-dev.yml file in the backend directory:


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

After the services are up and running, start the application:


mvn clean install
mvn 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: Email functionalities (e.g., account confirmation, password reset) won’t work without configuring SMTP. Check the Environment Variables section for the setup.

Running the Frontend

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


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

To start the UI, run:


pnpm install
pnpm run dev

You’re all set!