summaryrefslogtreecommitdiff
path: root/README.md
blob: 3dce04833ea0fa8a48d3a12e170b4a6c6abd7b17 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
# OpenCut (prev AppCut)

A free, open-source video editor for web, desktop, and mobile.

## Why?

- **Privacy**: Your videos stay on your device
- **Free features**: Every basic feature of CapCut is paywalled now
- **Simple**: People want editors that are easy to use - CapCut proved that

## Features

- Timeline-based editing
- Multi-track support
- Real-time preview
- No watermarks or subscriptions

## Project Structure

- `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

We welcome contributions! Please see our [Contributing Guide](.github/CONTRIBUTING.md) for detailed setup instructions and development guidelines.

Quick start for contributors:

- Fork the repo and clone locally
- Follow the setup instructions in CONTRIBUTING.md
- Create a feature branch and submit a PR

## License

MIT [Details](LICENSE)