Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dan5py/turborepo-cli-template
Turborepo template for CLI tool
https://github.com/dan5py/turborepo-cli-template
changesets cli commitlint eslint husky nextjs prettier shadcn-ui tailwindcss turborepo typescript
Last synced: 28 days ago
JSON representation
Turborepo template for CLI tool
- Host: GitHub
- URL: https://github.com/dan5py/turborepo-cli-template
- Owner: dan5py
- License: mit
- Created: 2024-01-26T12:08:20.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-01-27T12:48:31.000Z (10 months ago)
- Last Synced: 2024-04-24T04:46:22.744Z (7 months ago)
- Topics: changesets, cli, commitlint, eslint, husky, nextjs, prettier, shadcn-ui, tailwindcss, turborepo, typescript
- Language: TypeScript
- Homepage:
- Size: 93.8 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Turborepo starter for a CLI tool
This is a Turborepo starter for a CLI tool.
> [!NOTE]
> Built from [turborepo-shadcn-ui](https://github.com/dan5py/turborepo-shadcn-ui)
## Using this example
Install dependencies:
```sh
cd turborepo-cli-template
pnpm install
```
### Add ui components
Use the pre-made script:
```sh
pnpm ui:add
```
> This works just like the add command in the `shadcn/ui` CLI.
### Add a new app
Turborepo offer a simple command to add a new app:
```sh
pnpm turbo gen workspace --name
```
This will create a new empty app in the `apps` directory.
If you want, you can copy an existing app with:
```sh
pnpm turbo gen workspace --name --copy
```
> [!NOTE]
> Remember to run `pnpm install` after copying an app.
### Publish the CLI package
Authenticate your machine with NPM:
```sh
pnpm adduser
```
> [!NOTE]
> REMEMBER to change the name of the the CLI package in `packages/cli/package.json` (replace it also in the scripts)
Finally, publish the package:
```sh
pnpm pub:release
```
## What's inside?
This Turborepo includes the following packages/apps:
### Apps and Packages
- `docs`: a [Next.js](https://nextjs.org/) app
- `web`: another [Next.js](https://nextjs.org/) app
- `@repo/ui`: a stub React component library shared by both `web` and `docs` applications (🚀 powered by **shadcn/ui**)
- `@repo/eslint-config`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`)
- `@repo/typescript-config`: `tsconfig.json`s used throughout the monorepo
- `@repo/cli`: a CLI tool example
Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).
### Utilities
This Turborepo has some additional tools already setup for you:
- [TypeScript](https://www.typescriptlang.org/) for static type checking
- [ESLint](https://eslint.org/) for code linting
- [Prettier](https://prettier.io) for code formatting
### Build
To build all apps and packages, run the following command:
```sh
cd turborepo-shadcn-ui
pnpm build
```
### Develop
To develop all apps and packages, run the following command:
```sh
cd turborepo-shadcn-ui
pnpm dev
```
### Remote Caching
Turborepo can use a technique known as [Remote Caching](https://turbo.build/repo/docs/core-concepts/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](https://vercel.com/signup), then enter the following commands:
```
cd turborepo-shadcn-ui
npx turbo login
```
This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview).
Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your Turborepo:
```sh
npx turbo link
```
## Useful Links
Learn more about the power of Turborepo:
- [Tasks](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks)
- [Caching](https://turbo.build/repo/docs/core-concepts/caching)
- [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching)
- [Filtering](https://turbo.build/repo/docs/core-concepts/monorepos/filtering)
- [Configuration Options](https://turbo.build/repo/docs/reference/configuration)
- [CLI Usage](https://turbo.build/repo/docs/reference/command-line-reference)
Learn more about shadcn/ui:
- [Documentation](https://ui.shadcn.com/docs)