commIT Design

A React components library made by NUSSU commIT. More in-depth documentation can be found here.

Installation

In the project directory, you can run:

npm i commit-design

To use the components, simply

import { Button, Input } from 'commit-design'

To get started running the project locally, please follow the steps below. And before contributing, please read our contributing guidelines.

First, clone the repository.

git clone https://github.com/nussucommit/commIT-design.git

Then, install all the dependencies

cd commIT-design
npm install

Finally, run the storybook development server.

npm run storybook

Open http://localhost:6006 with your browser to see the result.