For quick browser-based development, open this project in Gitpod. It will automatically build an environment and run Storybook.

Nub design system

Nub UI is a web component built on top of Outline design system starter kit.

Outline is built with the following tools:

• Lit
• TypeScript
• CSS Custom Properties (CSS Vars)
• Tailwind CSS (Optional)
• Tailwind JIT Compiler
• Storybook
• Rollup

Contributing to Outline

Information regarding how to contribute to Outline development, can be found in CONTRIBUTING.md.

Local Setup

Run the following steps to ensure your environment is installed and up to date. This assumes you are using NVM locally to manage your NPM version(s).

Typescript

IMPORTANT: Supported Typescript versions are v4.4.4 to v4.5.0.

Checkout the repository

git clone [email protected]:hakkei-co/nub-ui.git && cd nub-ui

Ensure you are using the correct version of npm

nvm use

If you need to update your node version, see the usage documentation for nvm.

Install project dependencies

yarn install

To use nubs in another project

Fill in values for NPM_TOKEN_PRIVATE and NPM_TOKEN_DEFAULT in the file .env.

# .env
NPM_TOKEN_PRIVATE=xxxxxxxxxxxxxxxx
NPM_TOKEN_DEFAULT=yyyyyyyyyyyyyyyy

Create an .npmrc file using the following details.

@hakkei-co:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=${NPM_TOKEN_PRIVATE}
//registry.npmjs.org/:_authToken=${NPM_TOKEN_DEFAULT}

Install in an external project like so:

$ yarn add @hakkei-co/nub-ui@latest

Managing Registries

Point registry to Github registry

$ npm login --scope=@OWNER --registry=https://npm.pkg.github.com

Login using the access tokens provided for you. You can verify which registry you are using by running

$ yarn config list

# or for npm
$ npm config list

# you will need to manually specify which registry you are installing packages from if you override the default npm registry
$ npm i <some-package> --registry=https://npm.pkg.github.com

Storybook Development

Primary component development is done and demonstrated via Storybook.

Start storybook instance.

yarn start

Production builds

Runs both tsc and yarn rollup to handle the following:

• Packaging individual components to dist directory.
• Packaging modern and legacy builds of all components to dist directory.

yarn build

To only run the rollup build, which handles the component bundling into modern and legacy builds:

One time build

yarn rollup

Enable in watch mode

yarn rollup.watch

Resetting local environment

The following commands help clean a local environment.

• Cleanup generated assets: yarn clean
• Cleanup node packages: yarn reset
• Full cleanup & restart: yarn reboot