Skip to content
This repository has been archived by the owner on Aug 29, 2023. It is now read-only.

Latest commit

 

History

History
27 lines (20 loc) · 1.1 KB

README.md

File metadata and controls

27 lines (20 loc) · 1.1 KB
Raw

Template for CAS FEE ADV Design System

This is a template repository for the CAS FEE ADV design system part. It is configured to automatically provide GitHub Actions to build and deploy your design system as a static page and your component library to the GitHub package registry.

Getting started

After creating your assignment from this template, you'll need to install storybook and the base of your component library by yourself.

Deployment

This repository is configured to automatically deploy your design system to GitHub Pages and the component library to the GitHub package registry.

Please ensure the following prerequisites are met:

  • Storybook
    • Your package.json contains a build-storybook script
    • The resulting build is located in the storybook-static directory
  • Component Library
    • Your package.json contains a build script
    • When trying with npm pack, all your required files are included in the resulting tarball
    • Your package.json file contains the correct scope for your package (@smartive-education)
    • The package.json file contains the correct registry