summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMaze Winther <mazewinther@gmail.com>2025-07-17 17:19:23 +0200
committerMaze Winther <mazewinther@gmail.com>2025-07-17 17:19:23 +0200
commitce47e88e3482a55e4ed4c1c790ce85fd9109a2ee (patch)
tree671a1bc178b7a9ef11a9afe131b7160846d600a4 /README.md
parent9af8905c0c945766defb9b77990928e099a650bd (diff)
parent502725b98ec53b1668ceeae1a9f5463c64cdddf6 (diff)
downloadopencut-ce47e88e3482a55e4ed4c1c790ce85fd9109a2ee.tar.gz
Merge branch 'main' of https://github.com/mazeincoding/AppCut
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 18 insertions, 8 deletions
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