shunter-cli

Shunter CLI

CLI for shunterjs projects based on the shunterjs from springernature.

This library helps you to create shunter projects and manage them.

Installing project

$ npm install -g shunter-cli

Now, you can access directly shunter cli in your command line:

$ shunter

You will see some message like this:

Welcome to shunter-cli!
To generate a new project, please use \`shunter init [project name]\`
-------------------------------------------
examples:
    $ shunter init my-awesome-shunter

Initialize a new project

shunter-cli only manages projects created with itself. In other words, you can not append this cli into your existing project, unless you do a manual migration.

You can create a shunter project simply by:

shunter init my-project-name

init installs npm dependencies by itself, but anyway sometimes due to network problems it might fail, so you need to cd into directory of your my-project-name and run npm install, in case of any failure.

CLI Commands

When you are inside of your shunter-cli project directory, you can run commands below. If you are not in a shunter-cli project, ( even if it's a shunter project, but not generated with shunter init ) you won't be able to execute the commands.

Upgrade path to shunter-cli project will be release among first stable release of this repository

$ shunter init [project-name]
# Creates a new project within [project-name] directory.

$ shunter info
# Displays the shunter-cli project information

$ shunter serve
# Lifts the nodejs development server. It's based on nodemon, and only runs on 1 core because of development purposes.

CLI Todo Commands

Initial template features

---

1. When hovering over the links, a tooltip should appear
2. Images should appear inline to the left of the links
3. There must be no duplication of content
4. The template should use the data being sent from the backend application
5. The solution must not interfere with standard browser behaviour
6. HTML and CSS must validate
7. The principles of Progressive Enhancement must not be violated
8. Browser support: IE9+, latest stable release of Chrome, Firefox, Safari
9. Must be easy to maintain