-
Notifications
You must be signed in to change notification settings - Fork 36
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(CONTRIBUTING.md): add Setup section
- Loading branch information
Showing
1 changed file
with
21 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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`. | ||
|