summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPulkit Garg <pulkitgargbnl@gmail.com>2025-06-24 10:49:15 +0530
committerGitHub <noreply@github.com>2025-06-24 10:49:15 +0530
commitf0e305cfe6e0f519f9e12246bf0816d246b5fbf7 (patch)
treea0e3c402e2f5ddd4c9b63785878ad73a205a1326 /README.md
parente664ea0271a9c34bb7290447823367ba6fffac7d (diff)
parentaa6d42c517a3732a9fbd7ddb81de120ba0e4b545 (diff)
downloadopencut-f0e305cfe6e0f519f9e12246bf0816d246b5fbf7.tar.gz
Merge branch 'main' into main
Diffstat (limited to 'README.md')
-rw-r--r--README.md87
1 files changed, 66 insertions, 21 deletions
diff --git a/README.md b/README.md
index 3dce0483..407f5302 100644
--- a/README.md
+++ b/README.md
@@ -26,29 +26,74 @@ 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
- # 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)
+### 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:
@@ -59,4 +104,4 @@ Quick start for contributors:
## License
-MIT [Details](LICENSE)
+[MIT LICENSE](LICENSE)