xstefen/OpenCut
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: yeah

Browse Source
This commit is contained in:
Maze Winther
2025-07-01 19:26:42 +02:00
parent 5dfe9c0aac 394d9f684c
commit b14e9e82fe
1 changed files with 14 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -10,10 +10,6 @@
</tr> </tr>
</table> </table>
## Why? ## Why?
- **Privacy**: Your videos stay on your device - **Privacy**: Your videos stay on your device
@ -50,6 +46,7 @@ Before you begin, ensure you have the following installed on your system:
### Setup ### Setup
1. **Clone the repository** 1. **Clone the repository**
```bash ```bash
git clone <repo-url> git clone <repo-url>
cd OpenCut cd OpenCut
@ -57,29 +54,33 @@ Before you begin, ensure you have the following installed on your system:
2. **Start backend services** 2. **Start backend services**
From the project root, start the PostgreSQL and Redis services: From the project root, start the PostgreSQL and Redis services:
```bash ```bash
docker-compose up -d docker-compose up -d
``` ```
3. **Set up environment variables** 3. **Set up environment variables**
Navigate into the web app's directory and create a `.env` file from the example: Navigate into the web app's directory and create a `.env` file from the example:
```bash ```bash
cd apps/web cd apps/web
# Unix/Linux/Mac # Unix/Linux/Mac
cp .env.example .env.local cp .env.example .env.local
# Windows Command Prompt # Windows Command Prompt
copy .env.example .env.local copy .env.example .env.local
# Windows PowerShell # Windows PowerShell
Copy-Item .env.example .env.local Copy-Item .env.example .env.local
``` ```
*The default values in the `.env` file should work for local development.*
_The default values in the `.env` file should work for local development._
4. **Install dependencies** 4. **Install dependencies**
Install the project dependencies using `bun` (recommended) or `npm`. Install the project dependencies using `bun` (recommended) or `npm`.
```bash ```bash
# With bun # With bun
bun install bun install
@ -90,6 +91,7 @@ Before you begin, ensure you have the following installed on your system:
5. **Run database migrations** 5. **Run database migrations**
Apply the database schema to your local database: Apply the database schema to your local database:
```bash ```bash
# With bun # With bun
bun run db:push:local bun run db:push:local
@ -99,6 +101,7 @@ Before you begin, ensure you have the following installed on your system:
``` ```
6. **Start the development server** 6. **Start the development server**
```bash ```bash
# With bun # With bun
bun run dev bun run dev
@ -109,13 +112,12 @@ Before you begin, ensure you have the following installed on your system:
The application will be available at [http://localhost:3000](http://localhost:3000). The application will be available at [http://localhost:3000](http://localhost:3000).
---
## Contributing ## Contributing
Visit [CONTRIBUTING.md](.github/CONTRIBUTING.md) **Note**: We're currently moving at an extremely fast pace with rapid development and breaking changes. While we appreciate the interest, it's recommended to wait until the project stabilizes before contributing to avoid conflicts and wasted effort.
---
## Visit [CONTRIBUTING.md](.github/CONTRIBUTING.md)
We welcome contributions! Please see our [Contributing Guide](.github/CONTRIBUTING.md) for detailed setup instructions and development guidelines. We welcome contributions! Please see our [Contributing Guide](.github/CONTRIBUTING.md) for detailed setup instructions and development guidelines.
Quick start for contributors: Quick start for contributors: