Skip to content

Latest commit

 

History

History
55 lines (32 loc) · 1.97 KB

README.md

File metadata and controls

55 lines (32 loc) · 1.97 KB

Turbo Repo Template

A default template for a monorepo using pnpm and Turborepo.

Prerequisites

To get started install Node version 20+, and pnpm (globally).

Dependency Management

We use pnpm, for reasons mentioned here. Install all dependencies by running pnpm i in the root.

Project Structure

The template is configured as a pnpm workspace. There are two subfolders for code:

  • apps which contains all the apps.
  • packages which contains all shared code and configuration.

Building

For building and bundling, the following tools are included:

  • TSup for building and bundling Typescript libraries.
  • Typescript main development language.
  • Vite for building web applications.

Packages and apps can include build, dev, and typecheck scripts in their package.json so they can be executed through the root versions of those commands.

Code Style

Code style is determined by Biome. There are three code style commands included:

  • check: lints, formats, and fixes imports. Automatically run on commit.
  • format: formats the code
  • lint: lints code

These commands do not use turbo.

Testing

The following testing tools are included in dev dependencies:

Packages and apps can include e2e, test, and test:watch scripts in their package.json so they can be executed through the root versions of those commands.

Miscellaneous

The following are additional support tools:

  • Dotenv for managing environment variables. Includes dotenv-vault for storing environment variables securely only.
  • TSX for executing Typescript script files.