Quick Start

Get the Oloyid MVP stack running locally with Docker Compose. The full stack includes the FastAPI API, React admin portal, PostgreSQL, and Redis.

Prerequisites

• Docker 24+ and Docker Compose v2
• 4 GB RAM minimum
• Ports available: 3000, 5432, 6379, 8000

1. Clone and configure

git clone https://github.com/portaltickandtie-creator/oloyid-guardrails.git
cd oloyid-gurdrails
cp .env.example .env

2. Start the stack

docker compose up --build

Or run in the background:

docker compose up --build -d

3. Register your organization

On first visit, register an admin account and organization:

curl -X POST http://localhost:8000/api/v1/auth/register \
  -H "Content-Type: application/json" \
  -d '{
    "email": "admin@acme.com",
    "password": "securepass123",
    "name": "Admin User",
    "organization_name": "Acme Corp",
    "organization_slug": "acme"
  }'

4. Sign in to the admin portal

Open http://localhost:3000 and sign in with admin@acme.com / securepass123.

5. Make your first inference request

Authenticate and send a guarded completion request:

curl -X POST http://localhost:8000/api/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email": "admin@acme.com", "password": "securepass123"}'

# Use the returned access_token in subsequent requests
curl -X POST http://localhost:8000/api/v1/inference/completions \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "messages": [{"role": "user", "content": "Hello, how are you?"}],
    "model": "gpt-4o-mini"
  }'

Makefile commands

Next steps

• Understand the architecture and request lifecycle
• Configure guardrails and policies for your use case
• Deploy to production with environment-specific settings