https://github.com/thunderbird/services-ui
Shared components for Thunderbird Services Vuejs applications
https://github.com/thunderbird/services-ui
Last synced: 12 months ago
JSON representation
Shared components for Thunderbird Services Vuejs applications
- Host: GitHub
- URL: https://github.com/thunderbird/services-ui
- Owner: thunderbird
- License: mpl-2.0
- Created: 2024-07-16T18:15:26.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-05-09T23:36:35.000Z (about 1 year ago)
- Last Synced: 2025-06-09T21:08:29.271Z (about 1 year ago)
- Language: Vue
- Homepage: https://thunderbird.github.io/services-ui/
- Size: 10.3 MB
- Stars: 4
- Watchers: 6
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Services UI
A UI component library for use with Thunderbird Services
Note this is heavily work-in-progress.
## Usage
You can install the library by adding the following line as a dependency to your package.json:
```bash
npm i @thunderbirdops/services-ui
```
Then, include the stylesheet into your top-level component:
```ts
import "@thunderbirdops/services-ui/style.css";
````
We recommend you pull in the `Inter` font separately.
## Library Development
### Storybook
You can access storybook by running:
```bash
npm run storybook
```
### Building
You can build the library by running:
```bash
npm run build
```
### Publishing a new version
Once a release is deemed either a major update, minor update or patch update go ahead and update the version in package.json.
Once that's done commit it with the version number (i.e. if the new version is 0.6.1, commit just package.json with the message "0.6.1".)
After that create a tag for that commit as v$versionNumber (i.e. v0.6.1 from our previous example.) and draft and publish a new release based off that tag. The npm automation should kick in, and it should publish that new version soon.