📦 My React Widget

A simple React + MUI + Rollup + Vite test widget.

📘 Project Overview

A minimal widget package with React, MUI, Vite, and Rollup. A clean boilerplate react widget that will let you confirm creating npm packages and consuming a widget in another project.

✅ Features

Highlight the core functionalities your project offers.

• Responsive UI with Material-UI

⚠️ Limitations

• bare minimumn styling
• not design for production usage (e.g. testing only)

🛠 Tech Stack

• React
• Vite
• Material-UI

📁 Project structure

my-react-widget/
├── package.json
├── rollup.config.js
├── vite.config.js
├── src/
│   ├── index.js
│   ├── JustAWidget.jsx
│   └── SimpleButton.js
├── .gitignore
└── README.md

🏗 Creating & Building a widget

Instructions for building the project for production.

#1. Copy this boilerplate into a fresh folder `my-react-widget/`. Github repo ~ coming soon

git clone https://github.com/ore00/my-react-widget.git
cd my-react-widget

#2. Add your npm token to a .npmrc
cp .npmrc.copy .npmrc
#replace `npm_YOUR_TOKEN` with your npm access token

#3. Run:
npm install

# Optional: Lint and test
npm run lint
npm test

npm run build

#4. Check output:
npm pack --dry-run

#5. Publish:
npm publish --access public

Install

npm install my-react-widget-test

📎 Usage

import { JustAWidget, SimpleButton } from 'my-react-widget-test';

<JustAWidget />
<SimpleButton>Click</SimpleButton>

🤝 Contributions

This repository is primarily for personal use, but contributions are welcome.
If you have suggestions or improvements, feel free to fork the repository and submit a pull request.

Please follow conventional commits and write clear commit messages.

Commit Format:

type(scope?): description

body? (optional)

BREAKING CHANGE: explanation (if needed)

Examples:

• feat(auth): add login via OAuth
• fix: resolve layout crash on Safari
• chore: update dependencies
• refactor(db): rename user model
• BREAKING CHANGE: drop support for Node 14

Release Types:

| Type | Release Level | | ------------------ | ------------- | | feat: | Minor | | fix: | Patch | | BREAKING CHANGE: | Major |

📄 License

This project is licensed under the MIT License — see the LICENSE file for details.