milmilmilmil
Contributing

Development Setup

Set up a local development environment for milmil.

Prerequisites

  • Go 1.27+ — Backend API
  • Bun 1.3+ — Frontend build tool
  • FFmpeg — Media processing
  • Docker — For PostgreSQL and Redis (or install locally)

Getting Started

Clone the repository

git clone https://github.com/milmil-dev/milmil.git
cd milmil

Start infrastructure

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

This starts PostgreSQL and Redis for development.

Start the backend

cd api
cp .env.example .env
go mod download
make dev

The API server starts at http://localhost:8080 with hot reload.

Start the frontend

cd web
bun install
bun run dev

The dev server starts at http://localhost:5173 with HMR.

Repository Structure

go.mod
Makefile
package.json
docker-compose.yml
Makefile

Pull Request Guidelines

  1. Fork the repository and create a feature branch
  2. Write tests for new functionality
  3. Ensure make lint and make test pass
  4. Keep PRs focused — one feature or fix per PR
  5. Write clear commit messages describing the change

On this page