Turborepo starter
This is an official Yarn v1 starter turborepo.
What's inside?
This turborepo uses Yarn as a package manager. It includes the following packages/apps:
Apps and Packages
docs
: a Next.js appweb
: another Next.js appui
: a stub React component library shared by bothweb
anddocs
applicationsconfig
:eslint
configurations (includeseslint-config-next
andeslint-config-prettier
)tsconfig
:tsconfig.json
s 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
- Jest test runner for all things JavaScript
- Prettier for code formatting
Setup
This repository is used in the npx create-turbo
command, and selected when choosing which package manager you wish to use with your monorepo (Yarn).
Setup on Netlify (monorepo)
Setup each app using Netlify CLI (netlify init
into app folder) or Netlify UI pointing to the same repository.
In this example, I configured two apps (using NextJS).
After configuring each app, you can enable multiple commit notifications in Netlify UI.
Team settings > Sites > Notifications > Commit status notifications
.
So, when you open a pull request, you'll get a notification in your app.
Next steps 🚧
Use the same cache for all apps.
Build
To build all apps and packages, run the following command:
yarn run build
Develop
To develop all apps and packages, run the following command:
yarn run dev
Remote Caching
Turborepo can use a technique known as Remote Caching (Beta) 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 (Beta) you will need an account with Vercel. If you don't have an account you can create one, then enter the following commands:
npx 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:
npx turbo link
Useful Links
Learn more about the power of Turborepo: