Monorepo Turborepo Boilerplate
This is a monorepo boilerplate powered by Turborepo.
What’s inside?
This Turborepo includes the following packages and apps:
Apps and Packages
docs
: A placeholder documentation site powered by Next.jsweb
: A website site powered by Next.jsspa
: A SPA website site powered by create-react-app@my/core
: core React components@my/theme-kit
: A react UI theme kit powered by Tailwind and Headlessui@my/utils
: shared React utilities@my/tsconfig
: sharedtsconfig.json
s used throughout the monorepoeslint-preset-my
: ESLint preset
Each package and 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
- CommitLint for commit linting
Using this boilerplate
If you want to use this in the interim, you run the following command:
git clone https://github.com/MahdiTa97/turborepo-boilerplate
cd turborepo-boilerplate
yarn install
Changing the NPM organization scope
The NPM organization scope for this design system starter is @my
. To change this, it’s a bit manual at the moment, but you’ll need to do the following:
- Rename folders in
packages/*
to replacemy
with your desired scope - Search and replace
my
with your desired scope - Re-run
yarn install
Publishing packages
NPM
If you want to publish package to the public NPM registry and make them publicly available, this is already setup for you.
To publish packages to a private NPM organization scope, remove the following from each of the package.json
’s
- "publishConfig": {
- "access": "public"
- },