150 lines
5.1 KiB
Markdown
150 lines
5.1 KiB
Markdown
<p align="center">
|
|
<img src="public/banner.png" alt="waoowaoo" width="600">
|
|
</p>
|
|
|
|
<h1 align="center">waoowaoo AI Video Studio</h1>
|
|
|
|
<p align="center">
|
|
An AI-powered tool for creating short drama / comic videos — automatically generates storyboards, characters, and scenes from novel text, then assembles them into complete videos.
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="README.md">中文文档</a> · <a href="https://www.waoowaoo.com/">Join Waitlist</a> · <a href="https://github.com/saturndec/waoowaoo/issues">Report Bug</a>
|
|
</p>
|
|
|
|
> [!IMPORTANT]
|
|
> **Beta Notice**: This project is currently in its early beta stage. As it is currently a solo-developed project, some bugs and imperfections are to be expected. We are iterating rapidly — please stay tuned for frequent updates! We are committed to rolling out a massive roadmap of new features and optimizations, with the ultimate goal of becoming the top-tier solution in the industry. Your feedback and feature requests are highly welcome!
|
|
|
|
---
|
|
|
|
## ✨ Features
|
|
|
|
- 🎬 **AI Script Analysis** — Parse novels, extract characters, scenes & plot automatically
|
|
- 🎨 **Character & Scene Generation** — Consistent AI-generated character and scene images
|
|
- 📽️ **Storyboard Video** — Auto-generate shots and compose into complete videos
|
|
- 🎙️ **AI Voiceover** — Multi-character voice synthesis
|
|
- 🌐 **Bilingual UI** — Chinese / English, switch in the top-right corner
|
|
|
|
---
|
|
|
|
## 🚀 Quick Start
|
|
|
|
**Prerequisites**: Install [Docker Desktop](https://docs.docker.com/get-docker/)
|
|
|
|
### Method 1: Pull Pre-built Image (Easiest)
|
|
|
|
No need to clone the repository. Just download and run:
|
|
|
|
```bash
|
|
# Download docker-compose.yml
|
|
curl -O https://raw.githubusercontent.com/saturndec/waoowaoo/main/docker-compose.yml
|
|
|
|
# Start all services
|
|
docker compose up -d
|
|
```
|
|
|
|
> ⚠️ This is a beta version. Database is not compatible between versions. To upgrade, clear old data first:
|
|
|
|
```bash
|
|
docker compose down -v
|
|
docker rmi ghcr.io/saturndec/waoowaoo:latest
|
|
curl -O https://raw.githubusercontent.com/saturndec/waoowaoo/main/docker-compose.yml
|
|
docker compose up -d
|
|
```
|
|
|
|
> After starting, please **clear your browser cache** and log in again to avoid issues caused by stale cache.
|
|
|
|
### Method 2: Clone & Docker Build (Full Control)
|
|
|
|
```bash
|
|
git clone https://github.com/saturndec/waoowaoo.git
|
|
cd waoowaoo
|
|
docker compose up -d
|
|
```
|
|
|
|
To update:
|
|
```bash
|
|
git pull
|
|
docker compose down && docker compose up -d --build
|
|
```
|
|
|
|
### Method 3: Local Development (For Developers)
|
|
|
|
```bash
|
|
git clone https://github.com/saturndec/waoowaoo.git
|
|
cd waoowaoo
|
|
|
|
# Copy environment config (must be done before npm install)
|
|
cp .env.example .env
|
|
# ⚠️ Edit .env to fill in your AI API Keys (NEXTAUTH_URL defaults to http://localhost:3000, no change needed)
|
|
|
|
npm install
|
|
|
|
# Start infrastructure only
|
|
docker compose up mysql redis minio -d
|
|
|
|
# Run database migration
|
|
npx prisma db push
|
|
|
|
# Start development server
|
|
npm run dev
|
|
```
|
|
|
|
---
|
|
|
|
Visit [http://localhost:13000](http://localhost:13000) (Method 1 & 2) or [http://localhost:3000](http://localhost:3000) (Method 3) to get started!
|
|
|
|
> The database is initialized automatically on first launch — no extra configuration needed.
|
|
|
|
> [!TIP]
|
|
> **If you experience lag**: HTTP mode may limit browser connections. Install [Caddy](https://caddyserver.com/docs/install) for HTTPS:
|
|
> ```bash
|
|
> caddy run --config Caddyfile
|
|
> ```
|
|
> Then visit [https://localhost:1443](https://localhost:1443)
|
|
|
|
---
|
|
|
|
## 🔧 API Configuration
|
|
|
|
After launching, go to **Settings** to configure your AI service API keys. A built-in guide is provided.
|
|
|
|
> 💡 **Note**: Currently only official provider APIs are recommended. Third-party compatible formats (OpenAI Compatible) are not yet fully supported and will be improved in future releases.
|
|
|
|
---
|
|
|
|
## 📦 Tech Stack
|
|
|
|
- **Framework**: Next.js 15 + React 19
|
|
- **Database**: MySQL + Prisma ORM
|
|
- **Queue**: Redis + BullMQ
|
|
- **Styling**: Tailwind CSS v4
|
|
- **Auth**: NextAuth.js
|
|
|
|
---
|
|
|
|
## 📦 Preview
|
|
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
## 🤝 Contributing
|
|
|
|
This project is maintained by the core team. You're welcome to contribute by:
|
|
|
|
- 🐛 Filing [Issues](https://github.com/saturndec/waoowaoo/issues) — report bugs
|
|
- 💡 Filing [Issues](https://github.com/saturndec/waoowaoo/issues) — propose features
|
|
- 🔧 Submitting Pull Requests as references — we review every PR carefully for ideas, but the team implements fixes internally rather than merging external PRs directly
|
|
|
|
---
|
|
|
|
**Made with ❤️ by waoowaoo team**
|
|
|
|
## Star History
|
|
|
|
[](https://www.star-history.com/#saturndec/waoowaoo&type=date&legend=top-left)
|