@blaze/atoms
Version:
Open Source UI Toolkit - Atoms
42 lines (24 loc) • 1.42 kB
Markdown
# <a href="https://www.blazeui.com">Blaze Atoms</a>
Blaze is a framework-free open source UI toolkit. It provides great structure for building websites quickly with a scalable and maintainable foundation.
Blaze Atoms is a set of web components powered by Blaze CSS.
**https://www.blazeui.com**
## Ready to Code Dev Environment
Contribute to Blaze using an online development environment.
[](https://github.dev/BlazeSoftware/atoms)
## Local Developer Setup
First of all install [NVM](https://github.com/creationix/nvm#install-script).
When that is complete run:
```cli
$ nvm use
$ npm i
$ npm start
```
## Installing the JavaScript Components
Link to it by adding the following to your `<head></head>`.
```html
<script src="https://unpkg.com/@blaze/atoms@x.x.x/dist/blaze-atoms.js"></script>
```
The `x.x.x` is the specific version of the library, you should use specifc versions to prevent against breaking changes.
That's it! Start using the components in your HTML.
### Integrating with a Framework
Blaze uses [Stencil](http://stenciljs.com/) to compile our components into Web Components. And since they can be used within frameworks or in standard HTML websites the best resource to read is the [Stencil documentation](https://stenciljs.com/docs/overview) regarding framework integration.