README.md

Turborepo starter

This is a template to build monorepo program in typescript edited from official starter Turborepo.

What's inside?

This Turborepo includes the following packages/apps:

Apps and Packages

• docs: a Next.js app a static website doc powered by Eleventy
• web: a 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

And some other essential tools added to enforce code quality:

• Husky for git hooks
• lint-staged for linting staged files
• commitlint for commit message linting
• commitizen for commit message formatting

Commit

To commit, it is recommended to use

pnpm run commit

instead of git commit. This will use commitizen which will guide you to write a conventional commit message.

Build

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

pnpm build

Develop

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

pnpm dev

Generate Doc

To generate the 11ty-powered doc, run the following command:

pnpm run doc

Useful Links

Learn more about the power of Turborepo:

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