https://github.com/ping-maxwell/multiui-template-v1
This is the official template for creating MultiUI components.
https://github.com/ping-maxwell/multiui-template-v1
component multinite multiui
Last synced: 3 months ago
JSON representation
This is the official template for creating MultiUI components.
- Host: GitHub
- URL: https://github.com/ping-maxwell/multiui-template-v1
- Owner: ping-maxwell
- License: mit
- Created: 2024-07-31T11:36:49.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-11-09T05:18:01.000Z (7 months ago)
- Last Synced: 2025-03-02T04:28:34.676Z (3 months ago)
- Topics: component, multinite, multiui
- Language: TypeScript
- Homepage: https://multiui.org
- Size: 1.88 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# MultiUI Component Template
### This is an official starter template for creating a component for MultiUI.
## 🤔 What's inside
This project is a simple TurboRepo project containing the following folders:
- `packages/component`: Contains the source code for your component.
- `apps/demo-app`: Contains the source code for a NextJS demo app to render your component.
## ⭐️ How do I get started?
We recommend you read our documentation on creating a component for MultiUI:
https://multiui.org/docs/components/create-component
To get started, follow these steps:
1. install the dependencies:
```sh
pnpm install
```
2. Start development:
```sh
pnpm dev
```
There should be two instances running:
- NextJS dev server.
- TypeScript dev server watching your component.
You can now edit your component in the `packages/component/src` folder and see the changes in your browser.
## 🧪 What's next? Building, Testing & Linting
To build your component, run the following command:
```sh
npm run build
```
To test your component, run the following command:
```sh
npm run test
```
To lint your component, run the following command:
```sh
npm run lint
```
## 📜 What about publishing?
To publish your component, we recommend you read our documentation on publishing a component for MultiUI:
https://multiui.org/docs/components/publish-component