From f21b704323b8905f8a64c08feef27820898efc3c Mon Sep 17 00:00:00 2001 From: Anwarul Islam Date: Wed, 16 Jul 2025 04:34:25 +0600 Subject: [PATCH 1/5] docs: update README for clarity on setup instructions --- README.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index ad9a6d38..2f613c89 100644 --- a/README.md +++ b/README.md @@ -40,10 +40,15 @@ 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 +**Additional requirements for full-stack development:** + +- [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) (only needed for database/auth features) + +### Frontend-only Development (Recommended for UI work) + +If you're working on the UI/frontend and don't need authentication or database features: 1. Fork the repository 2. Clone your fork locally @@ -51,15 +56,13 @@ Before you begin, ensure you have the following installed on your system: 4. Install dependencies: `bun install` 5. Start the development server: `bun dev` -## Development Setup +The application will be available at [http://localhost:3000](http://localhost:3000). -### Prerequisites +**Note:** This setup runs without Docker and is perfect for frontend development, UI improvements, and most feature work. -- Node.js 18+ -- Bun (latest version) -- Docker (for local database) +### Full Development Setup (Database + Auth) -### Local Development +Only follow this if you need to work with authentication, user accounts, or database features. 1. Start the database and Redis services: From 6691e74db916f0869496853f1aa0cec8498aae7f Mon Sep 17 00:00:00 2001 From: Anwarul Islam Date: Wed, 16 Jul 2025 04:34:31 +0600 Subject: [PATCH 2/5] docs: update contributing guidelines for clarity on setup instructions --- .github/CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 77d7a6b6..4db3ad02 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -18,6 +18,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 +27,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 From f1fed515029ebdc7e29a976fd84b4e84cb0b5f03 Mon Sep 17 00:00:00 2001 From: Anwarul Islam Date: Wed, 16 Jul 2025 04:41:31 +0600 Subject: [PATCH 3/5] docs: update setup instructions to include environment file copying steps --- .github/CONTRIBUTING.md | 18 ++++++++++++++++-- README.md | 18 ++++++++++++++++-- 2 files changed, 32 insertions(+), 4 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 4db3ad02..cf46f6a5 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -7,8 +7,22 @@ Thank you for your interest in contributing to OpenCut! This document provides g 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: > diff --git a/README.md b/README.md index 2f613c89..c352bd91 100644 --- a/README.md +++ b/README.md @@ -53,8 +53,22 @@ If you're working on the UI/frontend and don't need authentication or database f 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`: + + ```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 dev` The application will be available at [http://localhost:3000](http://localhost:3000). From 4d028487e695baf9693ca74916193dd66c49524e Mon Sep 17 00:00:00 2001 From: Anwarul Islam Date: Thu, 17 Jul 2025 20:02:46 +0600 Subject: [PATCH 4/5] docs: clarify Docker setup note in contributing guidelines --- .github/CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index cf46f6a5..d6ce85ab 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -21,7 +21,6 @@ Thank you for your interest in contributing to OpenCut! This document provides g ``` 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: @@ -60,6 +59,8 @@ If you're unsure whether your idea falls into the preview category, feel free to - Bun (latest version) - Docker (for local database) +> **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 above in [Getting Started](#getting-started), you're all set to go! + ### Local Development 1. Start the database and Redis services: From f3307a64d1b17978cc0e129dbec645adaf34e3d3 Mon Sep 17 00:00:00 2001 From: Anwarul Islam Date: Thu, 17 Jul 2025 20:12:34 +0600 Subject: [PATCH 5/5] docs: reorganize prerequisites and setup instructions for clarity --- .github/CONTRIBUTING.md | 19 +++++++++++-------- README.md | 21 +++++++-------------- 2 files changed, 18 insertions(+), 22 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index d6ce85ab..75c4120b 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -4,6 +4,17 @@ 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` @@ -53,14 +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) - -> **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 above in [Getting Started](#getting-started), you're all set to go! - ### Local Development 1. Start the database and Redis services: diff --git a/README.md b/README.md index c352bd91..1378b15a 100644 --- a/README.md +++ b/README.md @@ -39,16 +39,14 @@ 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) -- [Node.js](https://nodejs.org/en/) (for `npm` alternative) + (for `npm` alternative) +- [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) -**Additional requirements for full-stack development:** +> **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! -- [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) (only needed for database/auth features) - -### Frontend-only Development (Recommended for UI work) - -If you're working on the UI/frontend and don't need authentication or database features: +### Setup 1. Fork the repository 2. Clone your fork locally @@ -67,16 +65,11 @@ If you're working on the UI/frontend and don't need authentication or database f ``` 5. Install dependencies: `bun install` - 6. Start the development server: `bun dev` -The application will be available at [http://localhost:3000](http://localhost:3000). +## Development Setup -**Note:** This setup runs without Docker and is perfect for frontend development, UI improvements, and most feature work. - -### Full Development Setup (Database + Auth) - -Only follow this if you need to work with authentication, user accounts, or database features. +### Local Development 1. Start the database and Redis services: