@edusynch/edusynch-ui NPM

About The Project

EduSynch UI is a set of user interface components built with the powerful toolset of Vite, React, MUI, and Storybook. By combining the development speed of Vite, the popularity and flexibility of React, the quality and customization of MUI, and the ease of use of Storybook, developers can easily create high-quality and high-performance education applications.

Built With

EduSynch UI is a collection of user interface components built with the powerful toolset of Vite, React, MUI, and Storybook. By combining the development speed of Vite, the popularity and flexibility of React, the quality and customization of MUI, and the ease of use of Storybook, developers can create high-quality and performant education applications with ease.

Getting started with Edusynch UI

Install the package on your project:

npm i @edusynch/edusynch-ui --save

yarn i @edusynch/edusynch-ui --save

Usage

First, you need to wrap your React app with the MainProvider:

import { MainThemeProvider, createTheme } from "@edusynch/edusynch-ui";
const theme = createTheme({});

return (
  <MainThemeProvider theme={theme}>
    Your Components here
  </MainThemeProvider>
)

Then you can import the components:

import { Card, Button } from "@edusynch/edusynch-ui";

return (
  <Card>
    <Button>This is an example</Button>
  </Card>
)

How can I publish a new version?

This is a private package. To publish it, you need to log in to your npm account or use an authToken.

First you need to run
```
npm run release
```
Then you need to publish the new release:
```
git push --follow-tags origin main 
```
Finally you need to publish on npm registry:
```
npm publish
```