README.md

Franken UI

Franken UI is an HTML-first, open-source library of UI components that works as a standalone or as a Tailwind CSS plugin. It is compatible with UIkit 3. The design is influenced by shadcn/ui.

Documentation

• Version 2 (preview)
• Version 1

Sponsors

Franken UI is an independent, MIT-licensed open source project with its ongoing development made possible entirely by the support of the community. If Franken UI has been beneficial to you in any way, please consider contributing by making a donation, which will help maintain and improve it for the benefit of everyone.

Thanks to the following:

And the amazing individuals from Ko-Fi who helped it since day one.

Development

Code contributions are now accepted from the community. To ensure effective collaboration and minimize potential conflicts, contributors are requested to reach out before starting work on any new features or bug fixes. This allows discussion of proposed changes, guidance on project architecture and coding standards, and ensures all contributions align with the project's overall vision.

To get started with development, please follow these steps:

• Clone the following three repositories into a single directory: franken-ui/ui, franken-ui/uikit, and franken-ui/webc.
• Navigate to the uikit directory and run the following commands:
  • npm install
  • npm run compile-js
  • npm link
• Next, navigate to the ui directory and run the following commands:
  • npm install
  • npm run package
  • npm link
• Finally, navigate to the webc directory and run the following commands:
  • npm install
  • npm link franken-ui uikit
  • npm link
• You are now ready to begin developing Franken UI.

License

Licensed under the MIT license.

Testing

This project is tested with BrowserStack