https://github.com/interconnectit/deckr
The UI framework that powers StandFirst
https://github.com/interconnectit/deckr
Last synced: 11 months ago
JSON representation
The UI framework that powers StandFirst
- Host: GitHub
- URL: https://github.com/interconnectit/deckr
- Owner: interconnectit
- License: mit
- Created: 2018-02-26T12:50:59.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-06-11T11:45:22.000Z (about 8 years ago)
- Last Synced: 2025-02-14T21:08:14.809Z (over 1 year ago)
- Language: CSS
- Homepage: https://interconnectit.github.io/deckr/
- Size: 621 KB
- Stars: 0
- Watchers: 6
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Deckr
[](https://www.npmjs.org/package/deckr)
[](https://travis-ci.org/interconnectit/deckr)
Deckr is the UI framework that powers StandFirst.
## Requirements
Make sure all dependencies have been installed before moving on:
* [Node](https://nodejs.org/en/)
* [NPM](https://docs.npmjs.com/getting-started/installing-node)
## Install
Pull the whole package via NPM:
``` sh
$ npm install --save deckr
```
Or, pull individual Deckr components via NPM:
``` sh
$ npm install --save deckr-reboot
```
## Usage
The source files included are written in [Scss](http://sass-lang.com/). After [installing](#install) with npm, you can add your project's `node_modules` directory to your Sass [include paths](https://github.com/sass/node-sass#includepaths), then import it like this:
``` scss
@import "deckr/main";
```
You can import individual Deckr components, for instance:
``` scss
@import "deckr-reboot/main";
```
## Testing
``` sh
$ npm run lint
```
## Security
If you discover any security related issues, please email support@interconectit.com instead of using the issue tracker.
## Credits
- [interconnect/it](https://interconnectit.com)
- [All Contributors](https://github.com/interconnectit/deckr/graphs/contributors)
## License
The MIT License (MIT). Please see [license file](LICENSE.md) for more information.