@billomat/billomat-ui-ts NPM

Billomat UI Library

Prerequistes

Create a .npmrc file in the root of the project to have access to some private company packages. ( If this file is not existing )

# .npmrc

# NPM AUTOMATION CI TOKEN
//registry.npmjs.org/:_authToken=*** AUTHTOKEN HERE ***

Install

$ git clone git@bitbucket.org:billomat/billomat-ui-ts.git
$ cd billomat-ui-ts
$ npm ci
$ code .                      // optional starting vscode

⚠️ Always use npm ci ⚠️

Usage

You can import from the main bundle:

import { Button } from "@billomat/billomat-ui-ts";

You also need to import Main CSS file to your project

@import "@billomat/billomat-ui-ts/src/scss/export.scss";

Start

$ npm start

➡️ Go to http://localhost:6006

Release

Perform the following steps to release a new version:

Create a release branch from production branch like release/vX.X.X
Merge all the branches that should be released to the release branch
Bump the version using npm version patch|[minor|major]
Merge into origin/production

⚠️ After merging the release branch into production-branch, npm publish will start automatically.

Deployments

➡️ Production: https://ui.billomat.com/

➡️ Development https://ui.dev.billomat.com/

Available scripts

$ npm run jest                // Run all tests
$ npm run jest -- --coverage  // Run all tests including coverage
$ npm run jest:watch          // Run tests on latest file changes
$ npm run eslint              // Run linter
$ npm run eslint:watch        // Run linter watcher on latest file changes
$ npm run stylint             // Run styleinter to check scss files
$ npm run test                // Run everything about tests in a single commmand