Tips to make make an addon demo site?

hugoruscitti · 2017-08-05 01:54:58 UTC

Hi, i’m working in a new ember addon but i wish to simplify the creation of the demo site. I wish to add some usage examples of my addon and some previews.

I think ember-cli-addon-docs is the way to go, but it seems to be WIP:

There is any alternative or some advice to make a demo site?

Thanks!

broerse · 2017-08-05 07:49:10 UTC

Use https://github.com/VerdigrisTech/ember-cli-deploy-ghpages . See how to do it here:

github.com

shipshapecode/ember-shepherd/blob/master/config/deploy.js

/* jshint node: true */

module.exports = function(deployTarget) {
  var ENV = {
    build: {},
    // include other plugin configuration that applies to all deploy targets here
    ghpages: {
      gitRemoteUrl: 'https://github.com/shipshapecode/ember-shepherd',
      domain: 'ember-shepherd.shipshape.io'
    }
  };

  if (deployTarget === 'development') {
    ENV.build.environment = 'development';
    // configure other plugins for development deploy target here
  }

  if (deployTarget === 'staging') {
    ENV.build.environment = 'production';
    // configure other plugins for staging deploy target here

This file has been truncated. show original

hugoruscitti · 2017-08-05 15:53:06 UTC

Thanks @broerse, but i looking for something like helpers or building blocks to create the content of the demo site, like components for snippets and documentation. I don’t have any issues deploying the demo site, instead my issue is with the building blocks to create the demo site.

This is an example of what i found: https://ember-learn.github.io/ember-cli-addon-docs/#/docs/components/docs-demo but seems to be unavailable to install in this moment

do you know some alternative? if you make an addon site do you will start it from scratch?

broerse · 2017-08-05 16:14:53 UTC

You can misuse the Dummy App and use that as demo like:

https://ember-intl.github.io/

https://github.com/ember-intl/ember-intl/tree/2.x/tests/dummy

So I would always create a normal Ember App as demo and deploy that.