turborepo-demo

🌳 Getting started official docs could be found here

A turbo repo monorepo management demonstration.

Table of Contents

• turborepo-demo
  • Table of Contents
  • Why
  • What's inside?
    • Apps and Packages
    • Utilities
    • Build
    • Develop
    • Remote Caching
  • Useful Links
  • License

Why

💡The documentation for why turborepo can be found here

• Rather than using the traditional polyrepo structure where shared modules are kept in separate repositories so they can be re-used, monorepo keeps all the dependent modules inside the same repository
• This eliminates the major drawback of polyrepo where when we need to update a shared module; we need to make a release and then put a PR for all the associated repos for version bump
• This is time consuming and touches upon several repos.
• Rather than touching several repos, monorepo keeps all the dependant modules in the same repo and leverages workspaces to use dependencies.

What's inside?

This turborepo uses pnpm as a package manager. It includes the following packages/apps:

Apps and Packages

• docs: a Next.js app
• web: another Next.js app
• ui: a stub React component library shared by both web and docs applications
• eslint-config-custom: eslint configurations (includes eslint-config-next and eslint-config-prettier)
• tsconfig: tsconfig.jsons used throughout the monorepo

Each package/app is 100% TypeScript.

Utilities

This turborepo has some additional tools already setup for you:

• TypeScript for static type checking
• ESLint for code linting
• Prettier for code formatting

Build

To build all apps and packages, run the following command:

cd my-turborepo
pnpm run build

Develop

To develop all apps and packages, run the following command:

cd my-turborepo
pnpm run dev

Remote Caching

Turborepo can use a technique known as Remote Caching to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.

By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can create one, then enter the following commands:

cd my-turborepo
pnpm dlx turbo login

This will authenticate the Turborepo CLI with your Vercel account.

Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your turborepo:

pnpm dlx turbo link

Useful Links

Learn more about the power of Turborepo:

• Tasks
• Caching
• Remote Caching
• Filtering
• Configuration Options
• CLI Usage

License

2023 © Murshid Azher.