Files
flatrender/README.md
T

61 lines
2.0 KiB
Markdown
Raw Normal View History

# FlatRender
2026-05-21 12:17:29 +03:30
AI-powered video and image creation platform. Create professional videos and images with templates, a drag-and-drop studio, and one-click export.
2026-05-21 12:17:29 +03:30
## Products
- **Video Maker** — timeline editor, Konva canvas, scene browser, transitions, audio, nexrender export
- **Image Editor** — Konva canvas, filters, crop, background removal, layer system
- **Video Trimmer** — ffmpeg.wasm in-browser trim + crop + export
- **Templates** — browsable marketplace with category sidebar
## Quick Start
2026-05-21 12:17:29 +03:30
```bash
npm install
cp .env.example .env.local # fill in your credentials
npm run dev # http://localhost:3000
2026-05-21 12:17:29 +03:30
```
## Related Repos
| Repo | Path | Purpose |
|---|---|---|
| flatrender | `D:\Projects\flatrender` | This repo — Next.js app |
| flatrender-admin | `D:\Projects\flatrender-admin\admin-api` | .NET 10 Admin API |
| flatrender-admin | `D:\Projects\flatrender-admin\admin-ui` | React Admin SPA |
2026-05-21 12:17:29 +03:30
## Stack
2026-05-21 12:17:29 +03:30
- **Next.js 15** App Router · TypeScript · Tailwind CSS · shadcn/ui
- **Supabase** — auth, database, storage
- **Stripe** — subscription payments
- **React-Konva** — canvas editor (video + image)
- **next-intl** — Persian (default) + English i18n
- **ffmpeg.wasm** — browser-side video trimming
- **nexrender** — server-side After Effects rendering
2026-05-21 12:17:29 +03:30
## Environment Variables
See `.env.example` for the full list. Minimum required to run:
```env
NEXT_PUBLIC_SUPABASE_URL=
NEXT_PUBLIC_SUPABASE_ANON_KEY=
```
2026-05-21 12:17:29 +03:30
Without Supabase the app runs in mock mode (studio uses localStorage).
2026-05-21 12:17:29 +03:30
## Database Migrations
2026-05-21 12:17:29 +03:30
Run in order in Supabase SQL Editor:
1. `supabase/migrations/001_profiles.sql`
2. `supabase/migrations/002_render_jobs.sql`
3. `supabase/migrations/003_projects.sql`
2026-05-21 12:17:29 +03:30
## Admin Panel
2026-05-21 12:17:29 +03:30
The admin panel at `D:\Projects\flatrender-admin` manages templates, categories, and media. When `ADMIN_API_URL=http://localhost:5000` is set, the Next.js app fetches live data from it. Without it, hardcoded fallback data is used.
2026-05-21 12:17:29 +03:30
See `CLAUDE.md` for full development guide.