Turborepo starter

This is an official starter Turborepo.

Using this example

Run the following command:

npx create-turbo@latest

What's inside?

This Turborepo includes the following packages/apps:

Apps and Packages

• docs: a Next.js app
• web: another Next.js app
• @swapnilsrivastava/ui: a stub React component library shared by both web and docs applications
• @swapnilsrivastava/eslint-config: eslint configurations (includes eslint-config-next and eslint-config-prettier)
• @swapnilsrivastava/typescript-config: 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:

npm run build

Develop

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

npm run dev

Deploy

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

Github Workflow Actions are deploying the packages Vercel is deploying the applications (apps and docs) at the moment.

Version

Version of the packages which are deployed to NPM Registry is done through changeset

npx changeset

Select which type of version you would want to upgrade(e.g. major (1.0.0), minor (0.2.0), patch(0.0.2) ) and on which package (e.g. @swapnilsrivastava/ui).

Once the above operation is performed by the contributer commit the file and push you changes to the branch and merge request is created. Github Action is programmed to create the pull request and remove the changeset *.md file and upgrade each package and add the change log for future references.

Remote Caching [NOT Activated for this project]

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:

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:

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