@black-isle-beef/novan-design-system

Token-driven Angular (v17+ standalone components) + Bootstrap 5 design system.

Install

npm install @black-isle-beef/novan-design-system bootstrap

Usage

import { DsHeroComponent, DsHeaderComponent } from '@black-isle-beef/novan-design-system';

@Component({
  standalone: true,
  imports: [DsHeroComponent, DsHeaderComponent],
  // ...
})
export class AppComponent {}

Add the compiled stylesheet to your app's global styles (angular.json):

"styles": ["node_modules/@black-isle-beef/novan-design-system/styles/styles.scss"]

Or import it directly in a root SCSS file:

@import '@black-isle-beef/novan-design-system/styles/styles';

Design tokens are also available as typed TypeScript constants:

import { colorTokens, SpacingScale } from '@black-isle-beef/novan-design-system';

This project was generated using Angular CLI version 22.1.0.

Code scaffolding

Angular CLI includes powerful code scaffolding tools. To generate a new component, run:

ng generate component component-name

For a complete list of available schematics (such as components, directives, or pipes), run:

ng generate --help

Building

To build the library, run:

npm run build:lib

This command builds the tokens first (build:tokens), then compiles the library with ng-packagr; build artifacts are placed in dist/design-system.

Publishing the Library

Publishing is automated via semantic-release from CI. To publish manually:

1. Navigate to the dist directory:

   cd dist/design-system

2. Run the npm publish command to publish your library to the npm registry:

   npm publish

Running unit tests

To execute unit tests with the Vitest test runner, use the following command:

ng test

Running end-to-end tests

For end-to-end (e2e) testing, run:

ng e2e

Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.

Additional Resources

For more information on using the Angular CLI, including detailed command references, visit the Angular CLI Overview and Command Reference page.