summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMaze Winther <mazewinther@gmail.com>2025-07-17 17:19:30 +0200
committerMaze Winther <mazewinther@gmail.com>2025-07-17 17:19:30 +0200
commite9ec13999abc9ec85c78f5d6e7eccb16d6a77386 (patch)
treeae7e3d3e2b265d9506c491672595edaed19b7901
parentbb9befc626db4696b3697d7573d6addc7e58aae7 (diff)
parentce47e88e3482a55e4ed4c1c790ce85fd9109a2ee (diff)
downloadopencut-e9ec13999abc9ec85c78f5d6e7eccb16d6a77386.tar.gz
Merge branch 'main' into staging
-rw-r--r--.github/CONTRIBUTING.md36
-rw-r--r--README.md26
2 files changed, 46 insertions, 16 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index 77d7a6b6..75c4120b 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -4,11 +4,35 @@ Thank you for your interest in contributing to OpenCut! This document provides g
## Getting Started
+### Prerequisites
+
+- [Node.js](https://nodejs.org/en/) (v18 or later)
+- [Bun](https://bun.sh/docs/installation)
+ (for `npm` alternative)
+- [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/)
+
+> **Note:** Docker is optional, but it's essential for running the local database and Redis services. If you're planning to contribute to frontend features, you can skip the Docker setup. If you have followed the steps below in [Setup](#setup), you're all set to go!
+
+### Setup
+
1. Fork the repository
2. Clone your fork locally
3. Navigate to the web app directory: `cd apps/web`
-4. Install dependencies: `bun install`
-5. Start the development server: `bun run dev`
+4. Copy `.env.example` to `.env.local`:
+
+ ```bash
+ # Unix/Linux/Mac
+ cp .env.example .env.local
+
+ # Windows Command Prompt
+ copy .env.example .env.local
+
+ # Windows PowerShell
+ Copy-Item .env.example .env.local
+ ```
+
+5. Install dependencies: `bun install`
+6. Start the development server: `bun run dev`
> **Note:** If you see an error like `Unsupported URL Type "workspace:*"` when running `npm install`, you have two options:
>
@@ -18,6 +42,7 @@ Thank you for your interest in contributing to OpenCut! This document provides g
## What to Focus On
**🎯 Good Areas to Contribute:**
+
- Timeline functionality and UI improvements
- Project management features
- Performance optimizations
@@ -26,6 +51,7 @@ Thank you for your interest in contributing to OpenCut! This document provides g
- Documentation and testing
**⚠️ Areas to Avoid:**
+
- Preview panel enhancements (text fonts, stickers, effects)
- Export functionality improvements
- Preview rendering optimizations
@@ -38,12 +64,6 @@ If you're unsure whether your idea falls into the preview category, feel free to
## Development Setup
-### Prerequisites
-
-- Node.js 18+
-- Bun (latest version)
-- Docker (for local database)
-
### Local Development
1. Start the database and Redis services:
diff --git a/README.md b/README.md
index ad9a6d38..1378b15a 100644
--- a/README.md
+++ b/README.md
@@ -39,25 +39,35 @@
Before you begin, ensure you have the following installed on your system:
+- [Node.js](https://nodejs.org/en/) (v18 or later)
- [Bun](https://bun.sh/docs/installation)
+ (for `npm` alternative)
- [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)
+
+> **Note:** Docker is optional, but it's essential for running the local database and Redis services. If you're planning to run the frontend or want to contribute to frontend features, you can skip the Docker setup. If you have followed the steps below in [Setup](#setup), you're all set to go!
### Setup
1. Fork the repository
2. Clone your fork locally
3. Navigate to the web app directory: `cd apps/web`
-4. Install dependencies: `bun install`
-5. Start the development server: `bun dev`
+4. Copy `.env.example` to `.env.local`:
-## Development Setup
+ ```bash
+ # Unix/Linux/Mac
+ cp .env.example .env.local
-### Prerequisites
+ # Windows Command Prompt
+ copy .env.example .env.local
-- Node.js 18+
-- Bun (latest version)
-- Docker (for local database)
+ # Windows PowerShell
+ Copy-Item .env.example .env.local
+ ```
+
+5. Install dependencies: `bun install`
+6. Start the development server: `bun dev`
+
+## Development Setup
### Local Development