Skip to content

The open-source CapCut alternative

docs: yeah

Maze Wintherb14e9e82fe5d
diff --cc README.md
index c5ecfe34,c5ecfe34..d4d063e0
--- a/README.md
+++ b/README.md
@@@ -10,10 -10,10 +10,6 @@@
</tr>
</table>
--
--
--
--
## Why?
- **Privacy**: Your videos stay on your device
@@@ -50,6 -50,6 +46,7 @@@ Before you begin, ensure you have the f
### Setup
1. **Clone the repository**
++
```bash
git clone <repo-url>
cd OpenCut
@@@ -57,29 -57,29 +54,33 @@@
2. **Start backend services**
From the project root, start the PostgreSQL and Redis services:
++
```bash
docker-compose up -d
```
3. **Set up environment variables**
Navigate into the web app's directory and create a `.env` file from the example:
++
```bash
cd apps/web
--
++
# Unix/Linux/Mac
cp .env.example .env.local
# Windows Command Prompt
copy .env.example .env.local
--
++
# Windows PowerShell
Copy-Item .env.example .env.local
```
-- *The default values in the `.env` file should work for local development.*
++
++ _The default values in the `.env` file should work for local development._
4. **Install dependencies**
Install the project dependencies using `bun` (recommended) or `npm`.
++
```bash
# With bun
bun install
@@@ -90,6 -90,6 +91,7 @@@
5. **Run database migrations**
Apply the database schema to your local database:
++
```bash
# With bun
bun run db:push:local
@@@ -99,6 -99,6 +101,7 @@@
```
6. **Start the development server**
++
```bash
# With bun
bun run dev
@@@ -109,13 -109,13 +112,12 @@@
The application will be available at [http://localhost:3000](http://localhost:3000).
-----
++## Contributing
++**Note**: We're currently moving at an extremely fast pace with rapid development and breaking changes. While we appreciate the interest, it's recommended to wait until the project stabilizes before contributing to avoid conflicts and wasted effort.
--## Contributing
++## Visit [CONTRIBUTING.md](.github/CONTRIBUTING.md)
--Visit [CONTRIBUTING.md](.github/CONTRIBUTING.md)
-----
We welcome contributions! Please see our [Contributing Guide](.github/CONTRIBUTING.md) for detailed setup instructions and development guidelines.
Quick start for contributors: