Getting Started

Prerequisites

Ensure the following are installed:

Tool	Version	Purpose
Rust	1.93.0+	Compiler (edition 2024)
PostgreSQL	18+	Primary database
Redis	8+	Sessions, cache, rate limiting, worker locks
NATS	2.12+	Job queue (JetStream)
MeiliSearch	1.30+	Full-text search engine
S3-compatible object storage	Latest	R2 assets storage (images, sitemap)

Clone and Setup

git clone https://github.com/levish0/AxumKit.git
cd AxumKit
cp .env.example .env

See Environment Variables for all required values.

Run Migrations

AxumKit uses SeaORM migrations.

cd crates/migration
cargo run -- up

Other commands:

cargo run -- down
cargo run -- fresh
cargo run -- status

Start the Server

cargo run -p server

API server starts at http://localhost:8000.

Start the Worker

In another terminal:

cargo run -p worker

The worker handles email delivery, user search indexing, and cron jobs.

Verify Setup

curl http://localhost:8000/health-check

Swagger UI (debug builds): http://localhost:8000/docs

Next Steps

• Study Guide
• Architecture
• Configuration