Contributing to Kurrier

Thank you for your interest in contributing to Kurrier!

This guide walks you through setting up the full development environment, including:

• ✔ Backend stack (Postgres, services, Redis, Typesense, Worker)
• ✔ Web dashboard (Next.js)

If you run into any issues, feel free to open an issue or PR — contributions of all kinds are welcome.

🚀 Getting Started

Kurrier uses Docker Compose . Start by ensuring you have the following installed:

• Docker

🛠️ Development Setup

git clone git@github.com:kurrier-org/kurrier.git
cd kurrier/db
mkdir -p local
cp example.develop.env local/.env
cp -rn init/* ./local/
cd local
docker compose up -d
cd ..
pnpm install && pnpm run dev

Branching Strategy

We use the following branching strategy to manage our codebase:

• main: The main branch contains the stable and production-ready code. All new features and bug fixes are merged into this branch after testing.
• develop: The develop branch is where the latest development changes are integrated. This branch serves as a staging area for new features before they are merged into the main branch.

🧭 Access the Dashboards

Once Docker finishes starting up, open the following URLs in your browser: