diff --git a/README.md b/README.md index 9114c27..724d9cc 100644 --- a/README.md +++ b/README.md @@ -56,114 +56,32 @@
and much more...

-## 💻 Development +## 🐋Deployment - 🐳 Docker Recommended - -**Quick Start:** - -```bash -docker compose -f docker-compose.yml \ - -f docker-compose.dev.yml up -d ``` - -**Ports:** - - - -- Frontend: `5173` -- Backend : `8000` -- FastAPI : `3000` - - -
- - 🛠️ Local Development - -For local development without Docker: - -```bash -# Install dependencies -pnpm install - -# Start services -pnpm run dev # Frontend (port 5173) -pnpm dlx tsx app/videorender/videorender.ts # Backend (port 8000) -uv run backend/main.py # FastAPI (port 3000) - -# Note: You'll need GEMINI_API_KEY for AI features -``` - -`Requirements` - - - -- Node.js 20+ -- Python 3.9+ -- PostgreSQL -- pnpm - - - - -## 🚀 Production - -**Quick Start:** - -```bash -docker compose up -d +git clone https://github.com/robinroy03/videoeditor.git +cd videoeditor +docker compose up ``` -**With Custom Domain:** +## 🧑‍💻Development -```bash -PROD_DOMAIN=yourdomain.com docker compose up -d ``` - -or alternatively edit `docker-compose.yml` - -**Ports:** - -- HTTP: `80` -- HTTPS: `443` - -## ⚙️ Environment Configuration - -Create a `.env` file for custom settings: - -```env -# Domain Configuration -PROD_DOMAIN=yourdomain.com - -# Database -DATABASE_URL=postgresql://user:pass@localhost:5432/videoeditor - -# Authentication (Google OAuth) -GOOGLE_CLIENT_ID=your_google_client_id -GOOGLE_CLIENT_SECRET=your_google_client_secret - -# AI Features (Optional -> /backend) -GEMINI_API_KEY=your_gemini_api_key - -# Supabase (Optional) -VITE_SUPABASE_URL=your_supabase_url -VITE_SUPABASE_ANON_KEY=your_supabase_key +pnpm i +pnpm run dev (frontend) +pnpm dlx tsx app/videorender/videorender.ts (backend) +uv run backend/main.py +flip `isProduction` to `false` in `/app/utils/api.ts` ``` -**Environment Variables Explained:** - -- `PROD_DOMAIN`: Your production domain (host only, e.g., `yourdomain.com`) -- `DATABASE_URL`: PostgreSQL connection string -- `GOOGLE_CLIENT_ID/SECRET`: Google OAuth credentials for authentication -- `GEMINI_API_KEY`: Required for AI-powered video editing features -- `VITE_SUPABASE_*`: Optional Supabase integration for additional features +## 📃TODO -
+We have a lot of work! For starters, we plan to integrate all Remotion APIs. I'll add a proper roadmap soon. Join the [Discord Server](https://discord.com/invite/GSknuxubZK) for updates and support. ## ❤️Contribution - We would love your contributions! ❤️ Check the [contribution guide](CONTRIBUTING.md). +We would love your contributions! ❤️ Check the [contribution guide](CONTRIBUTING.md). ## 📜License - This project is licensed under a dual-license. Refer to [LICENSE](LICENSE.md) for details. The [Remotion license](https://github.com/remotion-dev/remotion/blob/main/LICENSE.md) also applies to the relevant parts of the project. +This project is licensed under the MIT License. The [Remotion license](https://github.com/remotion-dev/remotion/blob/main/LICENSE.md) also applies to the relevant parts of the project. \ No newline at end of file