Skip to content

A tool for developing and documenting Angular component libraries

License

Notifications You must be signed in to change notification settings

etumyan/brewbox

Repository files navigation



Brewbox Logo

Brewbox Version Brewbox License



Installation

npm install brewbox

Usage

Stories definition

Create your stories describing them in files named *.stories.ts like so:

// button.stories.ts

import { ButtonComponent } from './button.component';

export default {
  title: 'Components/Button',
  component: ButtonComponent,
};

export const Primary = args => ({
  props: args,
});

Primary.args = {
  text: 'Button',
};

CLI

Help

Usage: brewbox [command]

Commands:
  serve [options]         Builds and serves in watch mode
  build [options]         Builds into an output directory
  version                 Outputs current version
  help                    Lists available commands

Serve

Usage: brewbox serve [options]

Options:
  --project               Specifies particular project in Angular workspace directory
  --verbose               Outputs additional information during execution

Build

Usage: brewbox build [options]

Options:
  --project               Specifies particular project in Angular workspace directory
  --verbose               Outputs additional information during execution