fe-component-library

Web CL

A mono repo based project which is used for building a component library using web components that can be reused across multiple projects and frameworks.

Motivation

This project will provide a reusable component library that will act as building blocks for several projects. It will solve the issue of reinventing the wheel where developers have to develop similar components for individual projects.

Repository overview

Provide an overview of the directory structure and files, for example:

 |- package.json => root workspace (private package used by yarn workspaces) 
 |--- packages 
 |------ header 
 |-------- package.json => standalone component utilizing lit.dev framework

Running instructions

Following are the steps that are needed to install the dependencies in this project locally:

• Clone this repository locally $ git clone https://github.com/yml-org/fe-component-library.git
• Install the dependencies. Inside the root $ yarn install

To run a package:

• In the terminal change the file path to the package directory $ cd packages/packageName
• Run the project using $ yarn start or yarn dev.

To run the storybook:

• In the root directory run $ yarn storybook

To run tests:

• In the root directory run $ yarn test
• To generate coverage reports run $ yarn test:coverage
• To run tests in watch mode run $ yarn test:watch

More resources

Some of the resources that will be helpful in understanding the codebase:

• Monorepo Architecture
• Lerna
• Web Components
• Lit.dev

About

This project is developed in order to provide a bedrock for subsequent projects that utilise component based architecture. Reach out to the following presons in case of any concerns:

• Shashanka Nataraj
• Ramya Nayak
• Aswathi S
• Abdul Ziyan
• Adithya S Shenoy
• Nilesh Kumar Sinha