Copyright © Ultimaker 2020-2021

This library contains components, styles, patterns, and designs for Stardust web applications.

Install using npm:

$ npm install stardust-web

NOTE: stardust-web is a private package that is hosted on GitHub packages. To install the package, you will need access. You can configure this in an .npmrc file in your project (preferred) or in your global .npmrc in your home directory. See .npmrc for an example and Development below on how to provide the GITHUB_TOKEN environment variable.

See usage for more information on how to use components from the library.

First clone the repository:

$ git clone [email protected]:Ultimaker/stardust-web

Development requires an environment variable GITHUB_TOKEN to be available. The most convenient way to do this is to export this token in your shell start-up files. Ask one of your colleagues for the value of this token.

Then change to the 'stardust-web' directory and install dependencies:

$ cd stardust-web
$ npm install

See tooling for more information on the various tools that are available in the project.

Every component should start with UM followed by the component name. Try to keep the component name and the filename the same.

Add a story file to ease development and make it visible in the storybook library. To make sure styling is visible within storybook. Add new stylsheets to _component-stylesheets.scss.

To use components in other apps, make sure the file get exported within src/index.ts

stardust-web is published to the GitHub NPM registry. For a detailed explanation see publishing.

Every merge to master, a static version of the Storybook is published on GitHub Pages.