Skip to content

Commit 64e0ee0

Browse files
committed
swamp drain
1 parent 8d62d6e commit 64e0ee0

1 file changed

Lines changed: 6 additions & 29 deletions

File tree

README.md

Lines changed: 6 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
## Features
2323

2424
- **PDF to Presentation**: Upload PDF slides and automatically extract them into a sequence of video scenes.
25-
- **AI-Powered Scripting**: Integrated with Google Gemini AI and [WebLLM](https://webllm.mlc-ai.org/) (Local Browser Inference) to transform fragmented slide notes into coherent, professional scripts.
25+
- **AI-Powered Scripting**: Integrated with [WebLLM](https://webllm.mlc-ai.org/) (Local Browser Inference) to transform fragmented slide notes into coherent, professional scripts.
2626
- **High-Quality TTS**: Supports local and cloud-based Text-to-Speech using [Kokoro-js](https://github.com/m-bain/kokoro-js).
2727
- **Local Inference**: Run TTS entirely locally via Dockerized Kokoro FastAPI.
2828
- **Hybrid Voices**: Create custom voice blends by mixing two models with adjustable weights.
@@ -73,29 +73,6 @@ To deploy this application using Docker, you **must first clone the repository**
7373
cd Origami-AI
7474
```
7575

76-
#### Using Docker Compose (Recommended)
77-
78-
A `docker-compose.yml` file is provided in the root directory. To start the application, run:
79-
80-
```bash
81-
docker-compose up -d
82-
```
83-
84-
Example `docker-compose.yml`:
85-
86-
```yaml
87-
services:
88-
origami-ai:
89-
build: .
90-
container_name: origami-ai
91-
ports:
92-
- "3000:3000"
93-
restart: unless-stopped
94-
environment:
95-
- PORT=3000
96-
- NODE_ENV=production
97-
```
98-
9976
#### Using Docker CLI
10077

10178
1. Build the image:
@@ -133,7 +110,7 @@ Scroll down to the **Configure Slides** panel to manage your project globally:
133110

134111
In the **Slide Editor** grid:
135112

136-
- **AI Scripting**: Click the **AI Fix Script** button (Sparkles icon) to have Gemini rewrite raw slide text into a natural spoken script.
113+
- **AI Scripting**: Click the **AI Fix Script** button (Sparkles icon) to rewrite raw slide text into a natural spoken script.
137114
- **Manual Editing**: Edit scripts directly. **Highlight** specific text sections to generate/regenerate audio for just that part.
138115
- **Generate Output**: Click the **Generate TTS** button (Speech icon) to create voiceovers.
139116
- **Preview**: Click the **Play** button to hear the result or click the slide thumbnail to expand the visual preview.
@@ -155,7 +132,8 @@ Open the **Settings Modal** (Gear Icon) to customize the application:
155132

156133
Configure the AI model used for script refinement ("AI Fix Script").
157134

158-
- **Google Gemini**: Built-in and recommended. Requires a [Google AI Studio](https://aistudio.google.com/) API Key.
135+
- **WebLLM (Default)**: Runs entirely in your browser using WebGPU. No API key required, completely free, and keeps your data private. Models are downloaded once and cached locally for fast inference.
136+
159137
- **Custom/OpenAI-Compatible**: Point to any OpenAI-compatible endpoint (e.g., LocalAI, Ollama, vLLM).
160138
- **Base URL**: Enter your provider's URL (e.g., `http://localhost:11434/v1`).
161139
- **Model Name**: Specify the model ID (e.g., `llama-3`).
@@ -178,7 +156,7 @@ You can build your own library of background music tracks that will be available
178156

179157
- **Frontend**: React 19, Vite, Tailwind CSS (v4)
180158
- **Video Engine**: FFmpeg WASM (Client-side)
181-
- **AI**: Google Gemini API & WebLLM (Local Browser Inference)
159+
- **AI**: WebLLM (Local Browser Inference)
182160
- **TTS**: Kokoro (FastAPI / Web Worker)
183161
- **Backend**: Express.js (serving as a rendering orchestration layer)
184162
- **Utilities**: Lucide React (icons), dnd-kit (drag & drop), pdfjs-dist (PDF processing)
@@ -191,7 +169,7 @@ You can build your own library of background music tracks that will be available
191169

192170
## Roadmap & TODO
193171

194-
- [ ] **YouTube Metadata Generator**: Automatically generate optimized titles and descriptions using Gemini.
172+
- [ ] **YouTube Metadata Generator**: Automatically generate optimized titles and descriptions.
195173
- [x] **Thumbnail Generator**: Create custom YouTube thumbnails based on slide content.
196174
- [ ] **Voiceover Recording**: Support for recording custom voiceovers directly within the app using a microphone.
197175
- [ ] **Header Layout Optimization**: Refactor and organize the application header for better aesthetics and usability.
@@ -208,7 +186,6 @@ This project is made possible by the following incredible open-source libraries
208186
- **[Lucide React](https://lucide.dev/)**: Beautifully crafted open-source icons.
209187
- **[dnd-kit](https://dndkit.com/)**: A modern, lightweight toolkit for drag-and-drop interfaces.
210188
- **[Dokploy](https://dokploy.com/)**: The open-source platform used for seamless self-hosting and deployment.
211-
- **[Google Antigravity](https://antigravity.google)**: The AI-powered IDE used to build and refine this project.
212189

213190
## License
214191

0 commit comments

Comments
 (0)