README.md
# Turborepo Template <img src="https://raw.githubusercontent.com/mayank1513/mayank1513/main/popper.png" style="height: 40px"/>
[](https://github.com/react18-tools/turborepo-template/actions/workflows/test.yml) [](https://codeclimate.com/github/react18-tools/turborepo-template/maintainability) [](https://codecov.io/gh/react18-tools/turborepo-template) [](https://www.npmjs.com/package/react18-loaders) [](https://www.npmjs.com/package/react18-loaders)  [](https://gitpod.io/from-referrer/)
> [Explore featured packages built with this template.](./FEATURED.md)
> Exciting news! We've launched a new course to help you master this template: [Craft Next Gen UI Libraries for React 18 and Next.js 14](https://www.udemy.com/course/craft-next-gen-ui-libraries-for-react-18-and-nextjs-14/?referralCode=46B8C7845ECCEA99E0EF)
<details>
<summary style="cursor:pointer"><h2 style="display:inline-block">Features</h2></summary>
This template offers the following pre-configured features. Additionally, your repository will automatically be rebranded with the help of workflows and post-install scripts.
✅ Monorepo powered by Turborepo and GitHub actions for automating building, testing, and deploying your library
✅ Examples with Next.js, Vite, and Remix to showcase how your library can be utilized (Note: Remix is optional due to instability in monorepo setup and folder imports)
✅ Examples pre-configured for Light/Dark theme based on user preference
✅ Examples ready to be deployed to Vercel
✅ Typedoc setup for automatic documentation generation based on tsdoc comments
✅ Code of Conduct and contributing files, ready for customization
✅ Prettier and linter configured according to modern best practices (Feel free to add your flavor)
✅ Recommended VSCode extensions - Prettier and [Kanban board](https://github.com/mayank1513/vscode-extension-trello-kanban-board) for code formatting and project management directly within your IDE
✅ Powerful code generators - try `yarn plop`
✅ Test setup with Vitest - A modern and fast testing framework supporting Jest-like APIs
✅ Workflows to automate testing on every pull-request or code push event
✅ Workflow to automatically publish and create GitHub releases when you update your library's `package.json` file.
✅ Workflow to automatically rebrand the entire template based on your repository name. (Refer [TODO.md](./TODO.md))
✅ Plus, this readme file includes a quick checklist for configuring Codecov and other badges, setting up your docs website on GitHub pages, and more. See [Checklist](./TODO.md).
### Creates a library that is
✅ Fully Treeshakable (e.g., import {Bars1, Bars2} from `react18-loaders/dist/server/bars`)
✅ Fully TypeScript Supported
✅ Leverages the power of React 18 Server components
✅ Compatible with all React 18 build systems/tools/frameworks
✅ Documented with [Typedoc](https://react18-tools.github.io/turborepo-template) ([Docs](https://react18-tools.github.io/turborepo-template))
</details>
## Getting Started:
This template is based on one of the official Turbo Repo starters but comes with a plethora of additional features specifically designed for developing and publishing JavaScript/TypeScript libraries, especially for React 18.
To get started, simply click on the `"Use this template"` button to create a new repository based on this template, \*\*update [`sripts/rebrand.config.json`](./scripts/rebrand.config.json) if required, and install dependencies(Will automatically trigger rebrand.js). Customize it according to your requirements for your next JavaScript/TypeScript/React/Next.js library or project.
For detailed instructions and a checklist, please refer to [TODO.md](./TODO.md).
## What's Different from Turborepo official templates?
Compared to the default scaffold from create-turbo, this template offers:
- Unit tests with `vitest`
- Build setup with `tsup` and `esbuild-plugin-react18` that supports React Server components out of the box
- **Automatic file generation**
- Simply run `yarn plop` and follow the prompts to auto-generate your new component with test files and dependency linking, adhering to best practices automatically
- GitHub actions/workflows to auto-publish your package when the version changes
- GitHub action/workflow + pre-install scripts to automatically rebrand your repo on creation
### 🤩 Don't forget to star [this repository](https://github.com/react18-tools/turborepo-template)!
Looking for a hands-on course to get started with Turborepo? Check out [React and Next.js with TypeScript](https://mayank-chaudhari.vercel.app/courses/react-and-next-js-with-typescript) and [The Game of Chess with Next.js, React, and TypeScript](https://www.udemy.com/course/game-of-chess-with-nextjs-react-and-typescript/?referralCode=851A28F10B254A8523FE)
## License
Licensed under the MPL-2.0 open-source license.
> <img src="https://raw.githubusercontent.com/mayank1513/mayank1513/main/popper.png" style="height: 20px"/> Please consider enrolling in [our courses](https://mayank-chaudhari.vercel.app/courses) or [sponsoring](https://github.com/sponsors/mayank1513) our work.
<hr />
<p align="center" style="text-align:center">with 💖 by <a href="https://mayank-chaudhari.vercel.app" target="_blank">Mayank Kumar Chaudhari</a></p>