docs: expand setup instructions with prerequisites and database setup steps

This commit is contained in:
babs
2025-06-23 20:59:31 +00:00
parent a6a520db70
commit a3e6585306

View File

@ -26,26 +26,66 @@ A free, open-source video editor for web, desktop, and mobile.
## Getting Started ## Getting Started
1. **Clone the repository:** ### Prerequisites
```bash
git clone <repo-url> Before you begin, ensure you have the following installed on your system:
cd OpenCut
``` - [Bun](https://bun.sh/docs/installation)
2. **Install dependencies:** - [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/)
```bash - [Node.js](https://nodejs.org/en/) (for `npm` alternative)
cd apps/web
npm install ### Setup
# or, with Bun
bun install 1. **Clone the repository**
``` ```bash
3. **Run the development server:** git clone <repo-url>
```bash cd OpenCut
npm run dev ```
# or, with Bun
bun run dev 2. **Start backend services**
``` From the project root, start the PostgreSQL and Redis services:
4. **Open in browser:** ```bash
Visit [http://localhost:3000](http://localhost:3000) 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 ## Contributing