summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYaoSiQian <admin@yaosiqian.cn>2025-06-24 05:06:21 +0800
committerGitHub <noreply@github.com>2025-06-24 05:06:21 +0800
commit79ac2c28238642436bc57a55671731460ccf2640 (patch)
treeb3e3cb28b30072370622bff87eec3c51a1916791
parentb772c6f68e81c4c88186219dc841a14ab278cf50 (diff)
downloadopencut-79ac2c28238642436bc57a55671731460ccf2640.tar.gz
style(README): hot fix at line break
-rw-r--r--README.md15
1 files changed, 12 insertions, 3 deletions
diff --git a/README.md b/README.md
index 998acd36..1c377b60 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,30 +41,37 @@ 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:**
+4. **Open in browser:**
+
Visit [http://localhost:3000](http://localhost:3000)
## Run with Docker
-1. **Prepare environment variables:**
+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)
## License
-MIT [Details](LICENSE)
+[MIT LICENSE](LICENSE)