Skip to content

Latest commit

 

History

History
107 lines (64 loc) · 3.12 KB

README.md

File metadata and controls

107 lines (64 loc) · 3.12 KB

Skill Recordings Projects

This is an exploratory project using Turborepo and pnpm to create a monorepo working environment for multiple applications and a shared common core library (or set of libraries.

Get Started

You'll need PNPM installed.

pnpm is used here based on significant performance gains reported by Jared Palmer from a customer.

install pnpm:

npm i pnpm@latest -g

Install all dependencies (all apps and packages) and build all apps and packages

pnpm install
pnpm build

This will build (and cache) the library packages and applications.

You can start an app or package for development:

cd apps/{{appname}} && pnpm dev
cd packages/{{packagename}} && pnpm dev

Adding a Project to Vercel

The build command needs to be scoped to the specific project so we aren't building all of the repos for every single run. The -w flag runs pnpm in the root of the project so all projects are built.

build:

The entire repo, all apps and dependencies

pnpm -w build

A single app/package can be filtered (from the root of the repo)

pnpm -- turbo run build --filter="testingaccessibility"

The install command needs to also add pnpm and then run install.

install:

npm i pnpm -g && pnpm i

Develop locally using vercel

Because of the way vercel handles monorepo projects, you can only have a single project linked locally at a given time.

In the root of the project:

vercel link
vercel dev

Calling vercel link asks if you want to link the project (yes), has you pick the account (skillrecordings), and finally you enter the project name for the project you are working on.

Repeat this process if you want to work on a different project.

Tools Used

Turborepo

abstracting the complex configuration needed for most monorepos into a single cohesive build system

Turbo is the core of the developer experience that this playground is exploring and provides cohesive logical building of a monorepo that contains many apps and library packages.

It's a closed source paid product that we are excited to use and support.

pnpm

Fast, disk space efficient package manager

performant npm is just what it says it is and a modern evolution of npm/yarn etc that follows the same conventions and gives efficiency in a monorepo environment and can shave a lot of time off of builds.

cypress

for integration and e2e testing!

Resources

Here's a general tour of Turborepo from Jared:

Jared Palmer gives Joel a tour of Turborepo - Watch Video

Some good examples and background in Jared's TSDX monorepo platground.

vercel logo