Skip to content

Commit

Permalink
docs(CONTRIBUTING.md): add Setup section
Browse files Browse the repository at this point in the history
  • Loading branch information
bludnic authored Sep 15, 2024
1 parent bf2aede commit 78c8848
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,27 @@ pnpm install turbo --global
docker -v
```

> [!WARNING]
> Due to a [bug](https://github.com/bludnic/opentrader/issues/53) in turbo that makes the Frontend app inaccessible in the browser, please use version `2.0.9` as a workaround.
```bash
pnpm i -g [email protected]
```

## Setup

1. Clone the repository:

```bash
git clone [email protected]:bludnic/opentrader.git
```

2. Clone Git submodules (optional). Run this only if you have access to the [opentrader-pro](https://github.com/bludnic/opentrader-pro) repository (private). Refer to the [UI](/CONTRIBUTING.md#UI) section below.

```bash
git submodule update --init
```

## Environment variables

The project uses a single `.env` file located in the root directory. Some packages may contain a symlink to the root `.env`.
Expand Down

0 comments on commit 78c8848

Please sign in to comment.