Go to file
Oleg Proskurin c185ea3ff4 feat: add Phase 1 foundation for API v2.0
Implement foundational components for Banatie API v2.0 with dual alias system,
flows support, and comprehensive type safety.

**Type Definitions:**
- Add models.ts with database types (Generation, Image, Flow, etc.)
- Add requests.ts with all v2 API request types
- Add responses.ts with standardized response types and converters
- Support for pagination, filters, and complex relations

**Constants:**
- Define technical aliases (@last, @first, @upload)
- Define reserved aliases and validation patterns
- Add rate limits for master/project keys (2-bucket system)
- Add pagination, image, generation, and flow limits
- Comprehensive error messages and codes

**Validators:**
- aliasValidator: Format validation, reserved alias checking
- paginationValidator: Bounds checking with normalization
- queryValidator: UUID, aspect ratio, focal point, date range validation

**Helpers:**
- paginationBuilder: Standardized pagination response construction
- hashHelper: SHA-256 utilities for caching and file deduplication
- queryHelper: Reusable WHERE clause builders with soft delete support

**Core Services:**
- AliasService: 3-tier alias resolution (technical → flow → project)
  - Technical alias computation (@last, @first, @upload)
  - Flow-scoped alias lookup from JSONB
  - Project-scoped alias lookup with uniqueness
  - Conflict detection and validation
  - Batch resolution support

**Dependencies:**
- Add drizzle-orm to api-service for direct ORM usage

All Phase 1 code is type-safe with zero TypeScript errors.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-09 21:53:50 +07:00
.claude chore: add agents 2025-10-05 23:10:50 +07:00
apps feat: add Phase 1 foundation for API v2.0 2025-11-09 21:53:50 +07:00
docs chore: update docs 2025-10-12 22:19:10 +07:00
packages/database fix: update schemes 2025-10-26 23:14:05 +07:00
prod-env feat: update setup 2025-10-12 21:12:58 +07:00
scripts feat: minio integration 2025-09-28 22:43:06 +07:00
tests chore: add test file 2025-09-21 23:57:40 +07:00
.dockerignore feat: add docker ignore 2025-09-27 00:32:36 +07:00
.env.example feat: log generation requests 2025-10-06 23:25:20 +07:00
.gitignore feat: update setup 2025-10-12 21:12:58 +07:00
.mcp.json feat: add DocPage 2025-10-21 22:47:45 +07:00
.prettierignore chore: prettier 2025-10-09 23:16:42 +07:00
.prettierrc.json feat: add prettier 2025-10-09 22:48:29 +07:00
CLAUDE.md chore: update docs 2025-10-12 22:19:10 +07:00
README.md feat: update setup 2025-10-12 21:12:58 +07:00
UPLOAD_COMPONENTS_DELIVERY.md feat: upload page 2025-10-11 01:02:13 +07:00
UPLOAD_PAGE_IMPLEMENTATION.md feat: upload page 2025-10-11 01:02:13 +07:00
banatie-api-requirements.md chore: update documentation 2025-11-09 21:24:14 +07:00
banatie-database-design.md feat: add documentation 2025-10-26 22:26:02 +07:00
banatie.code-workspace chore: add workspace 2025-10-04 00:47:01 +07:00
demo.test.ts feat: add test 2025-10-09 23:27:15 +07:00
infrastructure.md chore: prettier 2025-10-09 23:16:42 +07:00
minio-setup.md chore: prettier 2025-10-09 23:16:42 +07:00
package.json feat: update setup 2025-10-12 21:12:58 +07:00
pnpm-lock.yaml feat: add test 2025-10-09 23:27:15 +07:00
pnpm-workspace.yaml feat: implement apikey auth 2025-10-01 00:14:14 +07:00
test-api.sh feat: remove unused endpoints 2025-10-09 23:48:25 +07:00
test-filename-sanitization.js feat: filename sanitization 2025-10-11 18:11:56 +07:00
vitest.config.ts feat: add test 2025-10-09 23:27:15 +07:00

README.md

Banatie - AI Image Generation Service

A comprehensive monorepo for the Banatie AI image generation platform, featuring multiple applications for different use cases.

Architecture Overview

banatie-service/
├── apps/
│   ├── api-service/     # REST API for image generation (Express.js + TypeScript)
│   ├── landing/         # Landing page with demo (Next.js)
│   ├── studio/          # SaaS platform with billing (Next.js + Supabase + Stripe)
│   └── admin/           # Administration dashboard (Next.js)
├── data/                # Docker volumes (postgres, minio)
├── docker-compose.yml   # Infrastructure services
└── package.json         # Workspace scripts

Applications

🚀 API Service (apps/api-service)

  • Port: 3000
  • Tech: Express.js, TypeScript, Gemini AI
  • Purpose: Core REST API for AI image generation
  • Features: Image generation, file upload, rate limiting, logging

🌐 Landing Page (apps/landing)

  • Port: 3001
  • Tech: Next.js 14, Tailwind CSS
  • Purpose: Public landing page with demo
  • Features: Service overview, image generation demo

🏢 Studio (apps/studio)

  • Port: 3002
  • Tech: Next.js 14, Supabase, Stripe
  • Purpose: SaaS platform for paid users
  • Features: Authentication, billing, subscriptions, usage tracking

🔧 Admin (apps/admin)

  • Port: 3003
  • Tech: Next.js 14, Dashboard components
  • Purpose: Service administration and monitoring
  • Features: System monitoring, user management, analytics

Quick Start

Prerequisites

  • Node.js >= 18.0.0
  • pnpm >= 8.0.0
  • Docker & Docker Compose

Development Setup

# Clone and install dependencies
git clone <repository-url>
cd banatie-service
pnpm install

# Start infrastructure (PostgreSQL + MinIO)
docker compose up -d postgres minio storage-init

# Start all applications in development mode
pnpm dev

# Or start individual apps
pnpm dev:api      # API Service on :3000
pnpm dev:landing  # Landing Page on :3001
pnpm dev:studio   # Studio Platform on :3002
pnpm dev:admin    # Admin Dashboard on :3003

Production Deployment

# Build all applications
pnpm build

# Start infrastructure
docker compose up -d

# Start production servers
pnpm start:api
pnpm start:landing
pnpm start:studio
pnpm start:admin

Development Commands

# Install dependencies for all apps
pnpm install

# Development (all apps in parallel)
pnpm dev

# Build all apps
pnpm build

# Type checking
pnpm typecheck

# Linting
pnpm lint

# Testing (API service only)
pnpm test

# Clean all build outputs
pnpm clean

Environment Configuration

Each application has its own environment configuration:

  • Root: .env.docker (for Docker services)
  • API Service: apps/api-service/.env
  • Studio: apps/studio/.env.local
  • Admin: apps/admin/.env.local

See individual app README files for specific environment variables.

Services & Ports

Service Port Description
API Service 3000 Core REST API
Landing Page 3001 Public website
Studio Platform 3002 SaaS application
Admin Dashboard 3003 Administration
PostgreSQL 5460 Database
MinIO API 9000 Object storage
MinIO Console 9001 Storage admin

API Usage

Generate Image

# Text-to-image
curl -X POST http://localhost:3000/api/text-to-image \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
    "prompt": "A magical forest with glowing mushrooms",
    "filename": "magical_forest"
  }'

See apps/api-service/README.md for detailed API documentation.

Contributing

  1. Each app has its own package.json and dependencies
  2. Use the root workspace commands for multi-app operations
  3. Follow the existing code style and patterns
  4. Run pnpm typecheck and pnpm lint before committing

License

MIT License - see individual app directories for more details.