Skip to content

Commit a9dd66f

Browse files
authored
Merge pull request #1 from renlabs-dev/feat/docs-web-123
refactor: enhance installation guide (WEB-123)
2 parents c0e0d7f + 8084b29 commit a9dd66f

File tree

1 file changed

+24
-4
lines changed

1 file changed

+24
-4
lines changed

src/content/docs/web-apps/installation.mdx

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,16 @@ This guide will walk you through the process of installing and running the `toru
1616
## Prerequisites
1717

1818
- **Node.js** - `20.16.0` or higher.
19-
- **pnpm** - `9.7.1` or higher.
20-
- **just** - [installation guide](https://github.com/casey/just).
19+
- **PNPM** - `9.7.1` or higher.
20+
- **Docker** - [installation guide](https://docs.docker.com/get-docker/).
21+
- **Just** - [installation guide](https://github.com/casey/just).
22+
23+
##### Docker Tip
24+
25+
If you have difficulties or want alternatives to simplify using Docker, consider:
26+
27+
- [Colima](https://github.com/abiosoft/colima): A lightweight solution for running containers on macOS.
28+
- [Orbstack](https://orbstack.dev/): A fast and efficient alternative for managing containers.
2129

2230
## Monorepo setup
2331

@@ -80,7 +88,13 @@ This guide will walk you through the process of installing and running the `toru
8088
Create a postgres container with docker:
8189

8290
```bash
83-
docker run --name torus-db-container -e POSTGRES_PASSWORD=password -e POSTGRES_DB=torus-ts-db -d -p 1337:1337 docker.io/postgres
91+
docker run --name torus-db-container \
92+
-e POSTGRES_PASSWORD=password \
93+
-e POSTGRES_DB=torus-ts-db \
94+
-e POSTGRES_USER=postgres \
95+
-p 1337:1337 \
96+
-d postgres:16-alpine \
97+
postgres -p 1337
8498
```
8599

86100
Push the Drizzle schema to the database:
@@ -110,9 +124,15 @@ This guide will walk you through the process of installing and running the `toru
110124
From the root directory, run the following command:
111125

112126
```bash
113-
just run <app-name>
127+
just dev <app-name>
114128
```
115129

130+
<Aside>
131+
The `app-name` is the name of the app you want to run. You can find the
132+
list of apps in the `packages` directory. For example, to run the
133+
`torus-allocator` app, you would run `just dev torus-allocator`.
134+
</Aside>
135+
116136
From the app directory, run the following command:
117137

118138
```bash

0 commit comments

Comments
 (0)