Documentation for commIT-design. CommIT's React reusable components library.

Motivation

The biggest trend in frontend user interface (UI) development for the web in recent years has been towards components. It so happens to be that React, the frontend library that we decided to use, has in large part established patterns for building UIs out of small building blocks component parts.

Thus, we decided to create our very own React reusable components library in order to:

  1. Standardize design across all our web applications
  2. Speed up development time (as members do not need to make the basic components from scratch every time for different projects)
  3. Provide better documentation by using Storybook and thus we can onboard new members faster
  4. Help future management committees so they do not have to reinvent the wheel

Getting Started

To run the project on your local machine, read the instructions on our github repo.

Folder Structure

./src

All of our client-specific code will reside under the src directory, which will comprise of several different folders grouped by type.

./src/index.ts

Entry point of our component library. After creating a new component, you need to export it in this file or not it won't be accessible to our users.

./src/assets