docs: expand setup instructions with prerequisites and database setup steps

2025-06-23 20:59:31 +00:00
parent a6a520db70
commit a3e6585306
1 changed files with 60 additions and 20 deletions
--- a/README.md
+++ b/README.md
@ -26,26 +26,66 @@ 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