summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAnwarul Islam <anwaarulislaam@gmail.com>2025-07-16 04:41:31 +0600
committerAnwarul Islam <anwaarulislaam@gmail.com>2025-07-17 19:52:42 +0600
commitf1fed515029ebdc7e29a976fd84b4e84cb0b5f03 (patch)
tree79bb6d5b466103d5632ef6755bb828ded1307dd3 /README.md
parent6691e74db916f0869496853f1aa0cec8498aae7f (diff)
downloadopencut-f1fed515029ebdc7e29a976fd84b4e84cb0b5f03.tar.gz
docs: update setup instructions to include environment file copying steps
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 16 insertions, 2 deletions
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).