https://github.com/basmilius/flux
Flux is a component library for Vue 3.x.
https://github.com/basmilius/flux
components flux ui ui-components ui-framework vue vue3
Last synced: about 10 hours ago
JSON representation
Flux is a component library for Vue 3.x.
- Host: GitHub
- URL: https://github.com/basmilius/flux
- Owner: basmilius
- License: mit
- Created: 2024-04-19T11:07:12.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2026-03-07T09:16:51.000Z (4 days ago)
- Last Synced: 2026-03-07T15:55:35.191Z (3 days ago)
- Topics: components, flux, ui, ui-components, ui-framework, vue, vue3
- Language: Vue
- Homepage: https://flux-ui.dev
- Size: 5.29 MB
- Stars: 11
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Flux
This repository contains the source code of Flux UI.
Please read the following instructions and checks in order to proceed.
## 📦 Registry
- The UI library package is available under `@flux-ui/components`.
- The Dashboard library package is available under `@flux-ui/dashboard`.
- The internal package is available under `@flux-ui/internals`.
- The types package is available under `@flux-ui/types`.
## ⭐️ Prerequisites
- Bun >= 1.2.13
- Node.js >= 23
- Configure a new environment variable `FONTAWESOME_NPM_AUTH_TOKEN`. This should be a valid Font Awesome private npm auth token.
- Use `bun install` to install the required packages.
## 🪵 Git
All commit messages and branches will be in English.
### Branches
- **Main** — Contains the latest stable release and is the exact source that is running in production.
- **Develop** — Contains the latest staging release that is marked for deployment and is the exact source that is running on staging.
- **Feature branches** — Any feature should have its own feature branch. Once complete, the branch should be merged into the _develop_ branch and the feature branch should be deleted.
- **Bugfix branches** — When a bug is found, it should be fixed within a bugfix branch. Once complete the branch should be merged into the _develop_ branch and the feature branch should be deleted.
### Commit messages
Commit messages are bound to the following templates:
- `: `
- `(): `
- `(): []`
#### Examples
- `feat(expandable): adds header slot to expandable.`
- `feat(expandable): adds header slot to expandable. [FLUX-123]`
- `chore: adds vue 3 build target.`