Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/availity/availity-uikit
Availity UI Kit powered by Bootstrap 4
https://github.com/availity/availity-uikit
availity availity-uikit bootstrap css css-framework ui uikit
Last synced: 2 days ago
JSON representation
Availity UI Kit powered by Bootstrap 4
- Host: GitHub
- URL: https://github.com/availity/availity-uikit
- Owner: Availity
- License: mit
- Created: 2015-02-17T04:45:33.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-12-14T17:10:38.000Z (9 days ago)
- Last Synced: 2024-12-21T05:08:06.937Z (2 days ago)
- Topics: availity, availity-uikit, bootstrap, css, css-framework, ui, uikit
- Language: SCSS
- Homepage: https://availity.github.io/availity-uikit/v4
- Size: 24.6 MB
- Stars: 44
- Watchers: 41
- Forks: 26
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# availity-uikit
> Availity UI Kit powered by [Bootstrap 4](http://v4-alpha.getbootstrap.com/) with modifications to match Availity style guidelines
[](http://opensource.org/licenses/MIT)
[](https://npmjs.org/package/availity-uikit)
## Table of Contents
- [Demo](#demo)
- [Supported Browsers](#supported-browsers)
- [Quickstart](#quickstart)
- [Icon Fonts](#icon-fonts)
- [Contributing](#contributing)
- [Authors](#authors)
- [Disclaimer](#disclaimer)
- [License](#license)
## Demo
[http://availity.github.io/availity-uikit/v4](http://availity.github.io/availity-uikit/v4)
## Supported Browsers
- Google Chrome
- Mozilla Firefox
- Microsoft Edge
## Installation
Add the `availity-uikit` with the package manager of your choice
npm
```bash
npm install availity-uikit --save
```
or
Yarn
```bash
yarn add availity-uikit
```
## Icon Fonts
Availity uses [Fontello](http://fontello.com/) to manage icon fonts. Our [font configuration](./packages/uikit/fonts/config.json) can be used on Fontello to edit the font catalog.
### Updating Fonts
- Upload configuration to [Fontello](http://fontello.com/)
- After making changes, download zip and extract `font` folder into the uikit [font](./packages/uikit/fonts/)
- Replace the [font configuration](./packages/uikit/fonts/config.json) with the new one
- `yarn update-fonts` and commit changes
You can find more information on this process [here](https://github.com/fontello/fontello/wiki/How-to-save-and-load-projects)
## Contributing
This monorepo is managed with `yarn workspaces`. If you do not have `yarn` installed already then you will need to install it globally
```bash
npm i -g yarn
```
Install the dependencies
```bash
yarn install
```
Run the development server. Once running, it can be located at [http://localhost:8000](http://localhost:8000)
```bash
yarn start
```
Once the code has been merged into `master`, then you will need to publish the package to `npm`
```bash
yarn release
```
With the code published and the changes in GitHub, we will then need to deploy to `gh-pages`
```bash
yarn deploy
```
## Disclaimer
Open source software components distributed or made available in the Availity Materials are licensed to Company under the terms of the applicable open source license agreements, which may be found in text files included in the Availity Materials.
## License
[MIT](./LICENSE)