js-monorepo-template

A monorepo template for JavaScript/TypeScript projects.

What's inside?

This monorepo includes the following packages/apps:

Apps and Packages

Frontend Apps

• admin: a Refine app for the admin dashboard
• desktop: an Electron app for the desktop client app
• docs: a Docusaurus app for the documentation
• mobile: an Expo app for the mobile client app
• web: a Next.js app for the web client app
• website: an Astro app for the project website

Backend Apps

• users: a Hono app for the user management service

Infrastructure Apps

• api: a CDK app for the infrastructure as code

Packages

• ui: a React component library shared by applications, packed with Storybook for visual documentation.
• config: a shared configuration package (tsconfig, eslint, prettier, etc.)

Utilities

This monorepo has some additional tools already setup for you:

• TypeScript for static type checking
• ESLint for code linting
• Prettier for code formatting
• Jest for testing
• Vitest for unit testing
• Playwright for browser automation and testing
• Tailwind CSS for utility-first CSS
• pnpm for package management
• Turbo for monorepo management
• Commitlint for commit message linting
• Husky for Git hooks
• lint-staged for running linters on staged files
• Conventional Commits for commit message conventions
• Changesets for changelog and version management
• Renovate for automated dependency updates

Install

To install all dependencies, run the following command:

pnpm install

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

Lint and Format

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

pnpm lint

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

pnpm format

Test

To run all tests, run the following command:

pnpm test

Remote Caching

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:

pnpx 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:

pnpx turbo link

Useful Links

Learn more about the power of Turborepo:

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