# ember-frost-demo-components

> A collection of components and blueprints for showcasing frost components

Latest version **7.0.1** (published 2018-07-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install ember-frost-demo-components
pnpm add ember-frost-demo-components
yarn add ember-frost-demo-components
bun add ember-frost-demo-components
```

## Health

**Score 5/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: insecure dependencies; abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 7.0.1 |
| Published | 2018-07-20 |
| First published | 2016-04-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 6.0.0 |
| Dependencies | 17 |
| Unpacked size | 420.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Sophy Pal |
| Maintainers | ciena |
| Keywords | ember-addon, frost |

## Links

- npm: https://www.npmjs.com/package/ember-frost-demo-components
- Repository: https://github.com/ciena-frost/ember-frost-demo-components
- Homepage: https://github.com/ciena-frost/ember-frost-demo-components#readme
- Issues: https://github.com/ciena-frost/ember-frost-demo-components/issues
- npm.io page: https://npm.io/package/ember-frost-demo-components

## Dependencies (17)

- [ember-hook](https://npm.io/package/ember-hook.md) 1.4.2
- [ember-cli-sass](https://npm.io/package/ember-cli-sass.md) 7.1.1
- [ivy-codemirror](https://npm.io/package/ivy-codemirror.md) ^2.1.0
- [broccoli-funnel](https://npm.io/package/broccoli-funnel.md) ^2.0.1
- [ember-cli-babel](https://npm.io/package/ember-cli-babel.md) ^5.1.7
- [ember-browserify](https://npm.io/package/ember-browserify.md) ^1.2.0
- [ember-frost-core](https://npm.io/package/ember-frost-core.md) ^8.0.0
- [ember-prop-types](https://npm.io/package/ember-prop-types.md) ^7.0.2
- [ember-cli-htmlbars](https://npm.io/package/ember-cli-htmlbars.md) ^1.1.1
- [ember-cli-showdown](https://npm.io/package/ember-cli-showdown.md) ^2.11.0
- [ember-cli-svgstore](https://npm.io/package/ember-cli-svgstore.md) github:ciena-blueplanet/ember-cli-svgstore#977df1cf58ae43b1d98a591573c3e06947744321
- [ember-frost-popover](https://npm.io/package/ember-frost-popover.md) ^11.0.0
- [ember-truth-helpers](https://npm.io/package/ember-truth-helpers.md) ^1.3.0
- [broccoli-merge-trees](https://npm.io/package/broccoli-merge-trees.md) ^2.0.0
- [broccoli-babel-transpiler](https://npm.io/package/broccoli-babel-transpiler.md) ^5.7.2
- [ember-cli-version-checker](https://npm.io/package/ember-cli-version-checker.md) ~2.0.0
- [ember-computed-decorators](https://npm.io/package/ember-computed-decorators.md) 0.3.0

## Recent versions

- 7.0.1 (latest) — 2018-07-20
- 7.0.0 — 2018-05-14
- 6.0.0 — 2018-04-16
- 5.0.0 — 2018-03-19
- 4.0.0 — 2018-01-19
- 3.1.5 — 2018-01-02
- 3.1.4 — 2017-11-15
- 3.1.3 — 2017-08-11
- 3.1.2 — 2017-07-31
- 3.1.1 — 2017-07-17
- 3.1.0 — 2017-02-09
- 3.0.1 — 2017-01-11
- 3.0.0 — 2016-12-10
- 2.0.1 — 2016-12-04
- 2.0.0 — 2016-11-30
- … 8 more at https://npm.io/package/ember-frost-demo-components/versions

## README

[ci-img]: https://img.shields.io/travis/ciena-frost/ember-frost-demo-components.svg "Travis CI Build Status"
[ci-url]: https://travis-ci.org/ciena-frost/ember-frost-demo-components

[cov-img]: https://img.shields.io/coveralls/ciena-frost/ember-frost-demo-components.svg "Coveralls Code Coverage"
[cov-url]: https://coveralls.io/github/ciena-frost/ember-frost-demo-components

[npm-img]: https://img.shields.io/npm/v/ember-frost-demo-components.svg "NPM Version"
[npm-url]: https://www.npmjs.com/package/ember-frost-demo-components

[![Travis][ci-img]][ci-url] [![Coveralls][cov-img]][cov-url] [![NPM][npm-img]][npm-url]

# ember-frost-demo-components

A collection of components and blueprints for showcasing frost components

 * [Installation](#installation)
 * [Getting Started](#getting-started)
 * [Components](#components)
 * [Blueprints](#blueprints)
 * [Contributing](#development)


## Installation
```
ember install ember-frost-demo-components
```

## Getting Started

1. This *addon* installs `CodeMirror` and `Prism` for source editing and syntax highlighting.
You must update `ember-cli-build.js` to include options for those *addons* to bring in necessary themes.

  ```js
  var app = EmberApp(defaults, {
    codemirror: {
      modes: ['javascript', 'handlebars', 'markdown'],
      // frost-demo-editor defaults to 'mdn-like'
      themes: ['mdn-like']
    },
    'ember-prism': {
      // we use coy for frost demos
      theme: 'coy',
      components: ['javascript']
    }
    ...
  })
  ```

2. Update your application template to include `frost-demo-navbar`

  ```hbs
  {{frost-demo-navbar links=links}}
  {{outlet}}
  ```

3. Update your application controller with navigation links

  ```js
  export default Ember.Controller.extend({
    links: [
      {
        title: 'Demo Title',
        route: 'demo-route'
      }
    ]
  })
  ```

4. Generate a demo

  ```bash
  ember generate frost-demo my-demo --dummy --pod
  ```

  This generates the following files
  ```
  tests/dummy
    └── app/pods
      └── my-demo
        └── controller.js
        └── route.js
        └── template.hbs
        └── README.md
  ```

5. Update `router.js` with the new routes.

  ```js
  router.map('my-demo')
  ```

6. Continue steps 3-5 for each demo you want to generate.

## Components

The following components are available when you install ember-frost-demo-components

* [frost-demo-editor](frost-demo-editor.md)
* [frost-demo-navbar](frost-demo-navbar.md)

## Blueprints

This *addon* makes the `frost-demo` blueprint available to use to streamline creating demo pages.

```bash
ember generate frost-demo demo-1 --dummy --pod

# with fullscreen
ember generate frost-demo demo-2 --fullscreen --dummy --pod
```

## Development

### Setup
```
git clone git@github.com:ciena-frost/ember-frost-demo-components.git
cd ember-frost-demo-components
npm install && bower install
```

### Development Server
A dummy application for development is available under `ember-frost-demo-components/tests/dummy`.
To run the server run `ember server` (or `npm start`) from the root of the repository and
visit the app at http://localhost:4200.

### Testing
Run `npm test` from the root of the project to run linting checks as well as execute the test suite
and output code coverage.

---
_Source: https://npm.io/package/ember-frost-demo-components · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
