RomanNum3ral
/
OpenCut
mirror of https://github.com/OpenCut-app/OpenCut.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
.github/CONTRIBUTING.md vendored
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:

21
README.md
View File

@ -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: