STB single page application framework

Provides development environment and base components in a form of CommonJS modules for set-top box software production.

This framework is targeted on the client side and requires a building stage with Webpack or Browserify.

Getting Started

Node.js and NPM should be installed beforehand. Please follow the official instruction.

stb is available as an npm package and should be installed globally:

npm install -g stb

In Linux this can be done as a root:

sudo npm install -g stb

Usage

Create a new folder for your project and move to it:

mkdir myapp
cd myapp

Run the generator from within the new folder:

stb init

This will create all necessary files and folders (with smart conflict resolution mechanism in case there are already some files in the current directory) and install all necessary package dependencies.

To start working with a project it's necessary to make initial build and start all servers:

stb serve

General way of usage:

stb <command> [options]

Full list of available commands:

After the stb serve command the start page should open in the default browser. This page should be accessible remotely on the STB device via address.

It's possible to suppress a browser opening with

stb serve --no-open

In case remote access to STB device is enabled and configured in application ./config/ssh.js it's possible to activate one of the profiles:

stb serve --ssh [profile_name]

where profile_name is one of the following:

For example command stb serve --ssh will build and serve as usual but also connect to the STB device by SSH protocol and starts there a web browser with the debug version of application.

It's also possible to customize some commands execution with additional flags e.g. --clean, --develop, --release and so on. Full list of available options can be provided by the stb application:

stb --help
stb <command> --help

At runtime the development mode has a set of useful function available via keyboard shortcuts:

Illustrations of most approaches and components can be found in the demo application.

Help files generated from JSDocs comments in framework modules are available online.

Structure

Technologies

• Node.js
• Gulp
• Webpack
• UglifyJs
• Jade
• Qunit
• Less
• ESLint
• weinre
• code-proxy
• gremlins.js

Contribution

If you have any problem or suggestion please open an issue here. Pull requests are welcomed with respect to the JavaScript Code Style and included ESLint rules.

License

stb is released under the GPL-3.0 License.