From 315446c9eb3653f57c7fb0f1b384bf3c93fd0226 Mon Sep 17 00:00:00 2001 From: Nizav Date: Mon, 23 Jun 2025 15:33:06 +0700 Subject: [PATCH] docs: update readme, add project structure and bun commands --- README.md | 36 ++++++++++++++++++++++++++++++------ 1 file changed, 30 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 99db5b7..3ccb2b0 100644 --- a/README.md +++ b/README.md @@ -15,13 +15,37 @@ A free, open-source video editor for web, desktop, and mobile. - Real-time preview - No watermarks or subscriptions -## Development +## Project Structure -```bash -cd apps/web -npm install -npm run dev -``` +- `apps/web/` – Main Next.js web application +- `src/components/` – UI and editor components +- `src/hooks/` – Custom React hooks +- `src/lib/` – Utility and API logic +- `src/stores/` – State management (Zustand, etc.) +- `src/types/` – TypeScript types + +## Getting Started + +1. **Clone the repository:** + ```bash + git clone + cd OpenCut + ``` +2. **Install dependencies:** + ```bash + cd apps/web + npm install + # or, with Bun + bun install + ``` +3. **Run the development server:** + ```bash + npm run dev + # or, with Bun + bun run dev + ``` +4. **Open in browser:** + Visit [http://localhost:3000](http://localhost:3000) ## Contributing