The open-source CapCut alternative
Merge branch 'main' into main
iza69ab018f667b
diff --cc README.mdindex af2dbacd,fd475410..407f5302--- a/README.md+++ b/README.md@@@ -26,69 -26,61 +26,82 @@@ A free, open-source video editor for we## 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)--## Run with Docker-1. **Prepare environment variables:**-- Edit [docker-compose.yaml](https://github.com/OpenCut-app/OpenCut/blob/main/docker-compose.yaml#L57-L64)-2. **Build and run:**-- ```bash- docker-compose up -d --build- ```-3. *(Optional)* **Migrate database:**-- ```bash- docker-compose exec web bun run db:migrate- ```-4. **Open in browser:**-- Visit [http://localhost:3000](http://localhost:3000)+### Prerequisites++Before you begin, ensure you have the following installed on your system:++- [Bun](https://bun.sh/docs/installation)+- [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/)+- [Node.js](https://nodejs.org/en/) (for `npm` alternative)++### Setup++1. **Clone the repository**+ ```bash+ git clone <repo-url>+ cd OpenCut+ ```++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+ cp .env.example .env+ ```+ *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++ # Or with npm+ npm install+ ```++5. **Run database migrations**+ Apply the database schema to your local database:+ ```bash+ # With bun+ bun run db:push:local++ # Or with npm+ npm run db:push:local+ ```++6. **Start the development server**+ ```bash+ # With bun+ bun run dev++ # Or with npm+ npm run dev+ ```++The application will be available at [http://localhost:3000](http://localhost:3000).+++=======+++## Contributing+ 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:++ - 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)+ [MIT LICENSE](LICENSE)