docs: reorganize prerequisites and setup instructions for clarity

This commit is contained in:
Anwarul Islam
2025-07-17 20:12:34 +06:00
parent 4d028487e6
commit f3307a64d1
2 changed files with 18 additions and 22 deletions
+11 -8
View File
@@ -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: