orionx-cli

orionx-cli

Console scaffolding and development tool for Meteor Apps. Cutting edge fork

Contributing

Feel free to contribute. Please make pull requests to the develop branch.

Branches

• develop - cutting edge branch for the pull requests;
• orionx - this fork base branch, merged with develop branch. Key difference with master branch it is usage name orionx in the files README.md and package.json;
• master - orion-cli master branch

How to install

npm install -g orionx-cli

How to use

Creating apps

You can create meteor apps by using orionx create, which downloads the Meteor Boilerplate. --blank or -b let's you create a blank app (same as calling orionx init).

orionx create meteorApp
orionx create -b blankApp

If you have a proxy, you need to set the http_proxy variable to access the repository.

export http_proxy=http://myproxy.net:myport

Reset apps

You can reset the app to remove all the default code.

orionx init

Initializing exiting apps

Initialize Meteor Apps for use with scaffolding with following command.

cd existingMeteorApp
orionx init

The resulting file orion-config.json under private/ has existing templates, list them by calling orionx generate. The configuration has following structure.

{
    "generate" : {
        "templateName" : {
            "default" : {
                "desc" : "description for template",
                "files" : ["private/templates/someFile.html"],
                "variables" : [
                    {
                        "name" : "templateVar",
                        "desc" : "templateQuestion"
                    }
                ]
            },
            "otherProfileName" : {
                "files" : ["private/templates/someOtherFile.html"]
            }
        }
    }
}

The template file also has one required line of configuration, which looks like following.

<!-- { "path" : "client/views/__templateVar__.html" } -->
<template name="__templateVar__">
    <h1>This is the content</h1>
<template>

You can use the variables in the template, as long as the json configuration for the path is on the first line it'll recognize it.

Generating files

You can create views, routes, models and more in the default configuration or change it and add more templates.

orionx generate [entity] [name] [param]

Example:

orionx generate view
orionx generate routes

Advanced usage:

orionx generate view name-of-view
orionx generate routes category /category/:id

Change profiles

The default profiles in the configuration are es6 and coffee, which generates other kind of files. You can also define your own profiles.

orionx set-profile coffee