MyCareer Storybook Component Library

This repository contains the MyCareer component library, built using React, Material-UI (MUI), and Storybook. It is designed to be used with micro-frontend architecture using Qiankun.

Installation

To install the component library, use npm or yarn:

npm install myc-storybook

or

yarn add myc-storybook

Usage

Import the components you need from the library:

import { YourComponent } from 'myc-storybook';

function App() {
  return (
    <div>
      <YourComponent />
    </div>
  );
}

export default App;

Development

To set up the development environment, clone the repository and install the dependencies:

git clone https://github.com/GitHubLiffi/myc-storybook.git
cd myc-storybook
npm install

Running the Application

To start the development server, run:

npm start

This will start the application on http://localhost:3000.

Storybook

We use Storybook for developing and testing our components in isolation.

Running Storybook

To start Storybook, run:

npm run storybook

This will start Storybook on http://localhost:6006.

Building Storybook

To build the Storybook for production, run:

npm run build-storybook

Building the Library

To build the component library for distribution, run:

npm run build-lib

This will create the bundled files in the dist directory.

Considerations

• React and Mui Version Conflict: Mui5 currently requires a minimum of React 17, consider upgrading React when possible
• Storybook Version: Currently using Storybook 6.5.16. Consider upgrading to the latest version for new features and improvements(version 7/8)

Technologies

The main technologies used in this project are:

• React: ^16.14.0
• Material-UI (MUI): ^5.11.15
• Storybook: 6.5.16
• Qiankun: ^2.3.0
• TypeScript: ^4.6.3
• Rollup: ^2.75.0