Add README documentation

This commit is contained in:
Khoa VD 2026-04-28 17:51:56 +07:00
parent 6adb18f2af
commit bfcdfe2b6b

85
README.md Normal file
View file

@ -0,0 +1,85 @@
# KV App - AI Video Flow
AI-powered video creation app with workflow automation, TikTok trending analysis, and video generation.
## Features
- **AI Workflow Builder**: Create video workflows using AI agents (OpenCode, 34ai)
- **TikTok Trending**: Browse and analyze trending TikTok videos by region
- **Video Recreation**: Analyze trending videos and recreate with AI
- **Settings Management**: Configure API keys and preferences
## Getting Started
### Prerequisites
- Node.js 18+
- npm or yarn
### Installation
```bash
npm install
```
### Development
```bash
npm run dev
```
Open [http://localhost:3000](http://localhost:3000)
### Build
```bash
npm run build
npm start
```
## Configuration
Go to **Settings** page to configure:
- **OpenCode API Key**: Get from [opencode.ai](https://opencode.ai)
- **34ai API Key**: Get from [34ai.net](https://34ai.net)
## Tech Stack
- Next.js 14
- React 18
- Tailwind CSS
- Zustand (state management)
- React Flow (workflow builder)
## Project Structure
```
app/
├── api/
│ ├── opencode/ # OpenCode AI proxy
│ └── tiktok/ # TikTok trending API
├── settings/ # Settings page
├── shop/ # Shop page
├── trending/ # TikTok trending page
├── upload/ # Upload page
└── page.tsx # Main home page
components/
├── Header.tsx # Navigation header
└── tabs/
└── CreateTab.tsx
lib/
├── api/
│ ├── api34ai.ts # 34ai API client
│ └── opencode.ts # OpenCode API client
├── context/
│ └── SettingsContext.tsx
└── types/
└── index.ts
```
## License
MIT