Welcome to Zephyr Development

Zephyr is a monorepo built with Turborepo and Bun. You can run it natively on your machine or use Docker for infrastructure services.

Two Setup Paths

Path 1: Docker + Native Apps (Recommended)

Best for most developers - uses Docker for infrastructure, runs apps natively.

# 1. Clone and install
git clone https://github.com/zephverse/zephyr.git
cd zephyr
bun install
 
# 2. Configure environment
bun run env:dev
 
# 3. Start infrastructure (PostgreSQL, Redis, MinIO, etc.)
bun run docker:dev
 
# 4. Initialize database
bun run db:up
 
# 5. Run apps natively
bun run dev

Access your apps:

• Web: http://localhost:3000 
• Auth: http://localhost:3001 
• Docs: http://localhost:3002 

GUI Tools:

• Prisma Studio: http://localhost:5555 
• RedisInsight: http://localhost:5540 
• MinIO Console: http://localhost:9001 

Path 2: Full Docker

Run everything in containers (useful for production-like testing).

# 1. Clone repository
git clone https://github.com/zephverse/zephyr.git
cd zephyr
 
# 2. Start infrastructure
bun run docker:dev
 
# 3. Build and run apps
bun run docker:apps

Apps will be available at the same URLs but running inside Docker containers.

Quick Reference

What Gets Installed

When you run bun run docker:dev, these services start:

• PostgreSQL (5433) - Primary database
• Redis (6379) - Caching layer
• MinIO (9000/9001) - Object storage
• Meilisearch (7700) - Search engine
• RabbitMQ (5672/15672) - Message queue
• TimescaleDB (5434) - Time-series analytics
• Prisma Studio (5555) - Database GUI
• RedisInsight (5540) - Redis GUI

All services are configured and ready to use. No manual setup required!

Next Steps

1. Prerequisites - Install required tools
2. Installation - Detailed installation steps
3. Environment - Configure environment variables
4. Verification - Verify your setup works
5. Troubleshooting - Fix common issues