1.2 KiB

Raw Blame History

description	applyTo
Guidelines for bash commands and tooling in the monorepo	*/.sh

Bash & Tooling Instructions

This document outlines the standard tools and commands used in this monorepo.

Package Manager

We use pnpm for package management.

Do not use npm or yarn.
Lockfile: pnpm-lock.yaml
Workspace configuration: pnpm-workspace.yaml

Common Commands

Install dependencies: pnpm install
Run a script in a specific package: pnpm --filter <package_name> run <script>
Run a script in all packages: pnpm -r run <script>

Monorepo Tooling

We use Turbo for build system orchestration.

Configuration: turbo.json

Project Structure

apps/: Contains application services (admin, api, live, proxy, space, web).
packages/: Contains shared packages and libraries.
deployments/: Deployment configurations.

Running Tests

To run tests in a specific package (e.g., codemods):
```
cd packages/codemods
pnpm run test
```
Or from root:
```
pnpm --filter @plane/codemods run test
```

Docker

Local development uses docker-compose-local.yml.
Production/Staging uses docker-compose.yml.