docs: update setup instructions to include environment file copying steps
This commit is contained in:
parent
6691e74db9
commit
f1fed51502
|
|
@ -7,8 +7,22 @@ Thank you for your interest in contributing to OpenCut! This document provides g
|
||||||
1. Fork the repository
|
1. Fork the repository
|
||||||
2. Clone your fork locally
|
2. Clone your fork locally
|
||||||
3. Navigate to the web app directory: `cd apps/web`
|
3. Navigate to the web app directory: `cd apps/web`
|
||||||
4. Install dependencies: `bun install`
|
4. Copy `.env.example` to `.env.local`:
|
||||||
5. Start the development server: `bun run dev`
|
|
||||||
|
```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:
|
> **Note:** If you see an error like `Unsupported URL Type "workspace:*"` when running `npm install`, you have two options:
|
||||||
>
|
>
|
||||||
|
|
|
||||||
18
README.md
18
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
|
1. Fork the repository
|
||||||
2. Clone your fork locally
|
2. Clone your fork locally
|
||||||
3. Navigate to the web app directory: `cd apps/web`
|
3. Navigate to the web app directory: `cd apps/web`
|
||||||
4. Install dependencies: `bun install`
|
4. Copy `.env.example` to `.env.local`:
|
||||||
5. Start the development server: `bun dev`
|
|
||||||
|
```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).
|
The application will be available at [http://localhost:3000](http://localhost:3000).
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue