Merge pull request #31 from YaoSiQian/patch-1

Fix Docker stuff (with README guidance)

1 files changed, 25 insertions, 1 deletions

diff --git a/README.md b/README.md
index 3dce0483..fd475410 100644
--- a/README.md
+++ b/README.md
@@ -27,11 +27,13 @@ A free, open-source video editor for web, desktop, and mobile.
 ## Getting Started
 
 1. **Clone the repository:**
+
    ```bash
    git clone <repo-url>
    cd OpenCut
    ```
 2. **Install dependencies:**
+
    ```bash
    cd apps/web
    npm install
@@ -39,16 +41,38 @@ A free, open-source video editor for web, desktop, and mobile.
    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)
 
 ## 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:
@@ -59,4 +83,4 @@ Quick start for contributors:
 
 ## License
 
-MIT [Details](LICENSE)
+[MIT LICENSE](LICENSE)