diff options
| author | Maze <167211895+mazeincoding@users.noreply.github.com> | 2025-06-23 10:50:34 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-06-23 10:50:34 +0200 |
| commit | f940873bbf63ae79ff629eae920479be67c6b1d4 (patch) | |
| tree | a70d47718530226c22d8f09b0aa58fda3a738ca5 /README.md | |
| parent | e45e7e9f9d18f0ca368b92a24b0580f42c4be80d (diff) | |
| parent | 315446c9eb3653f57c7fb0f1b384bf3c93fd0226 (diff) | |
| download | opencut-f940873bbf63ae79ff629eae920479be67c6b1d4.tar.gz | |
Merge pull request #3 from Ni-zav/docs/update-readme
docs: update readme, add project structure and bun commands
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 36 |
1 files changed, 30 insertions, 6 deletions
@@ -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 <repo-url> + 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 |