An open API service indexing awesome lists of open source software.

https://github.com/runmedev/web

Monorepo for Web & React Components
https://github.com/runmedev/web

Last synced: 6 months ago
JSON representation

Monorepo for Web & React Components

Awesome Lists containing this project

README

          

# Runme Web (monorepo)

This project is structured as a pnpm workspace monorepo with two packages:

- **@runme/console** [@runmedev/react-console](https://www.npmjs.com/package/@runmedev/react-console): A React component library containing the Runme Console component.
- **@runme/components** [@runmedev/react-components](https://www.npmjs.com/package/@runmedev/react-components): A React component library containing the Runme components plus a example app.

## Getting Started

Set up pnpm to use Buf registry:

```sh {"name":"configure","terminalRows":"5"}
pnpm config set @buf:registry https://buf.build/gen/npm/v1
```

Install all dependencies:

```sh {"name":"setup"}
pnpm install
```

## Building

Build all packages:

```sh {"name":"build"}
pnpm run build
```

Build a specific package:

```sh
pnpm run build:console
pnpm run build:components
```

Clean up:

```sh {"name":"clean"}
pnpm run clean
```

## Development

Start the development server for sample app using the components:

```sh {"name":"dev"}
pnpm run build:console
pnpm run dev
```

## Testing

```sh {"name":"test"}
pnpm run test:run
```

## Linting

Lint all packages:

```sh {"terminalRows":"37"}
pnpm run lint
```

Lint a specific package:

```sh
pnpm --filter @runmedev/react-console run lint
pnpm --filter @runmedev/react-components run lint
```

## Structure

- `packages/react-components`: React component library (Runme)
- `packages/react-console`: Runme Console is a terminal attached to a Runme execution.

All dependencies are managed efficiently through pnpm's workspace features.