Skip to content

Latest commit

 

History

History
79 lines (53 loc) · 3.22 KB

README.md

File metadata and controls

79 lines (53 loc) · 3.22 KB
Raw

Monorepo Turborepo starter/boilerplate

This is a monorepo boilerplate powered by Turborepo.

You can also implement Monorepo with NX. It's boilerplate is HERE!

Using this example

Run the following command:

npx create-turbo@latest -e with-tailwind

What's inside?

This Turborepo includes the following packages and apps:

Apps and Packages

  • web: another Next.js app with Tailwind CSS
  • ui: a stub React component library with Tailwind CSS, daiysiui and daiysiui-react shared by both web applications
  • @repo/eslint-config: eslint configurations (includes eslint-config-next and eslint-config-prettier)
  • @repo/typescript-config: tsconfig.jsons used throughout the monorepo

Each package/app is 100% TypeScript.

Building packages/ui

This example is set up to produce compiled styles for ui components into the dist directory. The component .tsx files are consumed by the Next.js apps directly using transpilePackages in next.config.js. This was chosen for several reasons:

  • Make sharing one tailwind.config.js to apps and packages as easy as possible.
  • Make package compilation simple by only depending on the Next.js Compiler and tailwindcss.
  • Ensure Tailwind classes do not overwrite each other. The ui package uses a ui- prefix for it's classes.
  • Maintain clear package export boundaries.

Another option is to consume packages/ui directly from source without building. If using this option, you will need to update the tailwind.config.js in your apps to be aware of your package locations, so it can find all usages of the tailwindcss class names for CSS compilation.

For example, in tailwind.config.js:

  content: [
    // app content
    `src/**/*.{js,ts,jsx,tsx}`,
    // include packages if not transpiling
    "../../packages/ui/*.{js,ts,jsx,tsx}",
  ],

If you choose this strategy, you can remove the tailwindcss and autoprefixer dependencies from the ui package.

Utilities

This Turborepo has some additional tools already setup for you:

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 @repo. To change this, it's a bit manual at the moment, but you'll need to do the following:

  • Rename folders in packages/* to replace repo with your desired scope
  • Search and replace repo with your desired scope
  • Re-run yarn install