Skip to content

Latest commit

 

History

History
77 lines (46 loc) · 2.26 KB

README.md

File metadata and controls

77 lines (46 loc) · 2.26 KB
Raw

Clada storybook

clada-storybook is a design system component library build with react, tailwind and typescript.

This project was built in the frame of the CAS Frontend Engineering Advanced course at the OST Fachhochschule Rapperswil.

Authors/Developers:

  • Claudio Steffen
  • Danijel Malinovic

Installation and usage

If you want to review the package first before using it in your project, you can open our published storybook instance.

This package is intended to be used in a NextJS application. To install the package in your project simply run

npm install clada-storybook

After that, you need to import the stylesheet in your globals.css file:

@import 'clada-storybook/style.css';

Components that you want to use can be imported accordingly:

import { Button } from 'clada-storybook';

Local setup

To develop this application you ofcourse need node installed. For a seamless usage please use the version defined in the node-version file.

Then you need to install all dependencies:

npm ci

And after that you can run

npm run storybook

This will start the storybook instance on port 6006 and should automatically open.

License

This project is licensed under the MIT license agreement

Font

This package uses the "Poppins" font, created by Indian Type Foundry and Jonny Pinhorn, and is licensed under the Open Font License (OFL). Below, you can find the necessary attribution and license information:

Font Attribution

The "Example Font" font used in this package is licensed under the Open Font License (OFL), and it is the work of John Doe.

License

This font is released under the Open Font License (OFL).

OFL Summary

Contributing

Since this is a school project please do not open any pull requests for this repository.