shuffle-package-maker v1.0.8
Shuffle Package Maker
Shuffle is a visual editor for developers. It works with Tailwind CSS, Bootstrap, Bulma, and MUI.
This tool simplifies the process of creating a UI library package for Shuffle. You can upload your favorite purchased UI library (e.g., Tailwind UI, Flowbite) or one you made. For more details, see the Shuffle library upload documentation.
Installation
Install from github
- Clone this repository.
- Run
npm install
in the root directory.
Install via npm
- Install
shuffle-package-maker
via your package manager (eg.,npm install shuffle-package-maker
).
Usage
You can use presets to build packages for Tailwind UI and Flowbite components.
- Run
npx shuffle-package-maker DIRECTORY_NAME --preset PRESET_NAME
whereDIRECTORY_NAME
is the directory you want to scan for components andPRESET_NAME
is name of the preset you want to use. If you cloned the repository, run script directlynode generate.mjs
. - Follow the instructions in the terminal.
- Use the generated ZIP package and upload as new library in Shuffle.
Already available presets
Tailwind UI
tailwindui
- Tailwind UI components for all categories.tailwindui-marketing
- Tailwind UI marketing components.tailwindui-ecommerce
- Tailwind UI ecommerce components.tailwindui-application-ui
- Tailwind UI application UI components.
!TIP More details in Tailwind UI preset documentation.
!IMPORTANT(https://tailwindui.com) requires additional license which can be purchased from their website.
Flowbite
flowbite-marketing-ui
- Flowbite marketing UI components.flowbite-publisher-ui
- Flowbite publisher UI components.flowbite-admin-dashboard
- Flowbite admin dashboard components.
!TIP More details in Flowbite preset documentation.
!IMPORTANT(https://flowbite.com) requires additional license which can be purchased from their website.
Ayro UI
ayroui-bootstrap-ui-components
- Ayro UI Bootstrap UI components.
!TIP More details in Ayro UI preset documentation.
Other
You can also create your own preset by creating a new file in presets
directory. For details see PRESETS.md.
!TIP If you want share your preset with others, please feel free to create a pull request.
Additional
Run npm start
to see help