Skip to main content

Installation

Note: All commands should be run at the root of the project unless otherwise specified.

This guide will walk you through setting up the Cosailor Template development environment from scratch.

Prerequisites​

Before you begin, ensure you have the following installed:

Step-by-Step Installation​

1. Install pnpm​

If you don't have pnpm installed, run this command:

curl -fsSL https://get.pnpm.io/install.sh | sh -

On Windows, you can also install via npm:

npm install -g pnpm

2. Install Project Dependencies​

Navigate to the project root and install all dependencies:

pnpm install

This command will:

  • Install dependencies for all packages in the monorepo
  • Link internal packages together
  • Set up the workspace structure

3. Install Python Dependencies​

For the Core API backend, install Python dependencies:

pip install -r apps/core-api/requirements.txt

Alternatively, you can set up a virtual environment:

cd apps/core-api
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -r requirements.txt

4. Verify Installation​

To test that everything is installed correctly:

pnpm run dev

This command starts all development servers using Turborepo's parallel execution. You should see:

Please see the next section for how to configure the project (e.g. OAuth providers, environment variables, etc.).