/turborepo-starter

A starter monorepo built with Turborepo, Nextjs, Docker, Rollup, Typescript, Storybook, Jest and Tailwind.

Primary LanguageTypeScript

Turborepo starter (Next.js, TypeScript, Docker, ESLint, Jest, Prettier, Rollup.js, Tailwind, Storybook)

This is a Yarn v3 Turborepo (monorepo) starter.

What's inside?

This turborepo uses Yarn as a package manager. It includes the following packages/apps:

Apps and Packages

  • docs: a Next.js app
  • web: another Next.js app
  • admin: another Next.js app
  • ui: a stub React component library shared by docs, web, and admin applications
  • storybook: a Storybook.js app
  • config: eslint configurations (includes eslint-config-next and eslint-config-prettier)
  • tsconfig: tsconfig.jsons used throughout the monorepo

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
  • Rollup.js module bundler for packaging the component library
  • GitHub Actions for publishing the component library
  • Docker as an alternative build/development tool
  • Tailwind a utility first css framework for styling
  • Storybook.js build component driven UIs faster

Build

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

cd turborepo-starter
yarn run build

Develop

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

cd turborepo-starter
yarn run dev

or

cd turborepo-starter
docker-compose up --build

UI

Todo

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:

cd turborepo-starter
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: