https://github.com/keller-mark/pnpm-monorepo-example

Opinionated example repo containing library + demo site + documentation site
https://github.com/keller-mark/pnpm-monorepo-example

Last synced: about 1 month ago
JSON representation

Opinionated example repo containing library + demo site + documentation site

• Host: GitHub
• URL: https://github.com/keller-mark/pnpm-monorepo-example
• Owner: keller-mark
• Created: 2022-06-22T15:03:30.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-09-30T20:56:19.000Z (over 1 year ago)
• Last Synced: 2024-10-12T15:17:39.214Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 289 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# pnpm-monorepo-example

Opinionated toy example of monorepo that has the following things:

- Sub-packages published to NPM as JS libraries

  - JSX support for React

  - Web Worker example

  - SVG example

  - Both JS and TS sub-packages

- Sub-applications that import the sub-packages during development:

  - Simple development demo website

  - Docusaurus documentation website

- Testing and continuous integration

  - GitHub Actions workflows

  - Vitest for unit testing

  - Cypress for integration/end-to-end testing

  - Bundle size check action

- Changesets for automated releases and changelog updates

## Usage

```sh

npm install pnpm-monorepo-example

```

## Development

Install pnpm v7

### Setup

```sh

git clone 

pnpm install

```

### Run demo

```sh

pnpm start

```

### Lint and format

```sh

pnpm lint

pnpm format

```

### Build library

```sh

pnpm build

```

### Build demo

```sh

pnpm build-demo

```

### Monorepo tasks

```sh

pnpm meta-updater

```

## Deployment