Installation

This guide will walk you through the process of installing and running the torus-ts monorepo.

Prerequisites

• Node.js - 20.16.0 or higher.
• PNPM - 9.7.1 or higher.
• Docker - installation guide.
• Just - installation guide.

Docker Tip

If you have difficulties or want alternatives to simplify using Docker, consider:

• Colima: A lightweight solution for running containers on macOS.
• Orbstack: A fast and efficient alternative for managing containers.

Monorepo setup

1. Clone the repository

   SSH

   git clone [email protected]:renlabs-dev/torus-ts.git

   Clone using the web URL.

   HTTPS

   https://github.com/renlabs-dev/torus-ts.git

   Use a password-protected SSH key.

   GitHub CLI

   gh repo clone renlabs-dev/torus-ts

   Use the GitHub CLI.

   
   

2. Install the dependencies

   pnpm install
   # or
   just install

   
   

3. Configure environment variables

   There is an .env.example in the root directory you can use for reference

   cp .env.example .env

   
   

4. Setup database

   Note

   This step is only required for the torus-allocator & torus-dao apps.

   Create a postgres container with docker:

   docker run --name torus-db-container \
     -e POSTGRES_PASSWORD=password \
     -e POSTGRES_DB=torus-ts-db \
     -e POSTGRES_USER=postgres \
     -p 1337:1337 \
     -d postgres:16-alpine \
     postgres -p 1337

   Push the Drizzle schema to the database:

   just db-push

   You can also use the just db-studio command to open a GUI provided by Drizzle.

   
   

5. Build the project

   just build

   Caution

   This step is required before running any app since @torus-ts/subspace needs to be builded and imported indirectly, otherwise dependant packages may typecheck it’s sources and cause conflict in the generated/augmented types.

   
   

6. Run the project

   From the root directory, run the following command:

   just dev <app-name>

   Note

   The app-name is the name of the app you want to run. You can find the list of apps in the packages directory. For example, to run the torus-allocator app, you would run just dev torus-allocator.

   From the app directory, run the following command:

   pnpm run dev

   Note

   To run apps from their directories, you need to set up the environment variables inside the app directory aswell.