Quick Start Guide

Get the Pricing Engine running in 5 minutes.

Prerequisites

• Docker and Docker Compose installed
• Git for cloning the repository

🚀 Setup Steps

1. Clone Repository (if not already)

cd /path/to/projects
git clone https://github.com/hungryhub-team/pricing-engine.git
cd pricing-engine

2. Start Services

# Start PostgreSQL, Redis, and API
docker-compose up -d

# Verify services are running
docker-compose ps

Expected output:

NAME                    STATUS
pricing-engine-api      Up
pricing-engine-db       Up
pricing-engine-redis    Up

3. Run Database Migrations

docker-compose exec api bundle exec rails db:migrate

4. Verify API is Running

curl http://localhost:3001/health

Expected response:

{
  "status": "ok",
  "timestamp": "2025-12-09T10:30:00Z"
}

🧪 Test the API

Option 1: Using Postman (Recommended)

1. Open Postman
2. Import collection: docs/postman/Pricing_Engine_API.postman_collection.json
3. Import environment: docs/postman/Pricing_Engine_Local.postman_environment.json
4. Select “Pricing Engine - Local” environment
5. Get an OAuth token from your authentication service
6. Try: Pricing Rules → List Rules

See POSTMAN_GUIDE.md for detailed setup.

Option 2: Using cURL

# Get OAuth token first (from your auth service)
TOKEN="your_bearer_token"

# List pricing rules
curl -X GET http://localhost:3001/api/partner/v1/pricing_rules \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json"

✅ Verification Checklist

• Docker containers running (docker-compose ps)
• Database migrated successfully
• Health endpoint returns {"status":"ok"}
• Can authenticate with Bearer token
• Can list pricing rules

🐛 Common Issues

Port 3001 Already in Use

# Check what's using the port
lsof -ti:3001

# Stop and restart
docker-compose down
docker-compose up -d

Database Connection Error

# Reset database
docker-compose down -v
docker-compose up -d
docker-compose exec api bundle exec rails db:setup

Authentication Failed

• Verify PARTNER_ENGINE_BASE_URL in environment
• Check OAuth token is valid
• Ensure token is prefixed with Bearer

📖 Next Steps

Now that your environment is running:

1. Understand Authentication: AUTHENTICATION.md
2. Explore DateTime Rules: datetime-rule/README.md
3. Read API Reference: API_REFERENCE.md
4. Setup Postman: postman/SETUP_GUIDE.md

🛠️ Useful Commands

# View logs
docker-compose logs -f api

# Run tests
docker-compose exec api bundle exec rspec

# Rails console
docker-compose exec api bundle exec rails console

# Stop services
docker-compose down

# Rebuild after code changes
docker-compose down
docker-compose build api
docker-compose up -d

Estimated Time: ⏱️ 5 minutes
Difficulty: 🟢 Beginner
Next: AUTHENTICATION.md