https://github.com/waldronmatt/pnpm-turborepo-auto-boilerplate

A monorepo boilerplate using pnpm, turborepo, and auto.
https://github.com/waldronmatt/pnpm-turborepo-auto-boilerplate

auto automated boilerplate changelog monorepo-boilerplate npm pnpm pnpm-workspaces publishing turborepo turborepo-example versioning

Last synced: about 3 hours ago
JSON representation

A monorepo boilerplate using pnpm, turborepo, and auto.

• Host: GitHub
• URL: https://github.com/waldronmatt/pnpm-turborepo-auto-boilerplate
• Owner: waldronmatt
• License: mit
• Created: 2022-11-24T02:51:09.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2022-12-08T01:26:50.000Z (almost 2 years ago)
• Last Synced: 2024-04-25T02:03:14.737Z (7 months ago)
• Topics: auto, automated, boilerplate, changelog, monorepo-boilerplate, npm, pnpm, pnpm-workspaces, publishing, turborepo, turborepo-example, versioning
• Language: JavaScript
• Homepage:
• Size: 597 KB
• Stars: 38
• Watchers: 3
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# pnpm | turborepo | auto

A monorepo boilerplate using `pnpm` (installer), `turborepo` (task-runner), and `auto` (publisher).

Boilerplate based on the turborepo [kitchen sink starter](https://github.com/vercel/turbo/tree/main/examples/kitchen-sink).

## Installation

Install dependencies:

```bash

pnpm i

```

Install hooks:

```bash

pnpm prepare

```

## Getting Started

Set up auto and follow the prompts

```bash

pnpm auto init

```

[Create your `GH_TOKEN` and `NPM_TOKEN` for versioning and publishing.](https://intuit.github.io/auto/docs/welcome/getting-started#2-configure-environment-variables)

**Note**: Make sure to set up your `NPM_TOKEN` via `Settings` -> `Secrets` -> `Actions`

Create `GitHub` labels:

```bash

pnpm auto create-labels

```

[Create and set up your `TURBO_TOKEN` and `TURBO_TEAM` for task running remote caching](https://turbo.build/repo/docs/ci/github-actions#remote-caching).

## Commands

Commit changes using conventional changelog:

```bash

pnpm commit

```

Lint files:

```bash

pnpm lint

```

Run tests with coverage:

```bash

pnpm test

```

Run tests in watch mode:

```bash

pnpm test:watch

```

Clean up bundle artifacts (dist, typescript, jest), compile files, and build bundle:

```bash

pnpm build

```

Compile files and build bundle:

```bash

pnpm build:prod

```

Run tests against bundle:

```bash

pnpm test:prod

```

## License

MIT