Skip to content

Latest commit

 

History

History
138 lines (85 loc) · 3.26 KB

README.md

File metadata and controls

138 lines (85 loc) · 3.26 KB
Raw

Teonet node-webkit application generator NPM version

Yeoman generator to create new Teonet server node-webkit application. The Teonet Server application can execute under Linux or Mac OS only. This readme file shows terminal commands for Debian, Ubuntu or Linux Mint.

Usage

Installation

First, install Yeoman, generator-teonet-webkit using npm and NWJS (we assume you have pre-installed NodeJS and Build Essential).

npm install -g yo
npm install -g generator-teonet-webkit

Install teonet library

https://www.npmjs.com/package/generator-teonet#install-teonet-library

Generate your new teonet-webkit project

yo teonet-webkit

Compile your application with grunt

grunt

Run you application with NWJS application

nw dist --enable-logging=stderr APPNAME teo-APPNAME

Build your webkit application

grunt build-nwjs

Run your webkit application executable file

build-nwjs/teo-nw/linux64/APPNAME --enable-logging=stderr APPNAME teo-APPNAME

Generators

Available generators:

App

Create new Teonet server node-webkit application.

Example:

yo teonet-webkit

Controller

Generates a controller in app/scripts/controllers.

Example:

yo teonet-webkit:controller user

Produces app/scripts/controllers/user.js:

angular.module('myMod').controller('UserCtrl', function ($scope, teonet) {
  // ...
});

Developer Notes

Clone this project code

This project uses git submodule, so after cloning this project from git execute next command:

git submodule update --init

Some Teonet documentation

Teonet developer documentation:
http://repo.ksproject.org/docs/teonet/

Teonet events:
http://repo.ksproject.org/docs/teonet/ev__mgr_8h.html#ad7b9bff24cb809ad64c305b3ec3a21fe

Publish project to NPM

If you haven't already set your NPM author info, now you should:

npm set init.author.name "Your Name"
npm set init.author.email "you@example.com"
npm set init.author.url "http://yourblog.com"

npm adduser

Publish project to NPM:

npm publish ./

Getting To Know Yeoman

  • Yeoman has a heart of gold.
  • Yeoman is a person with feelings and opinions, but is very easy to work with.
  • Yeoman can be too opinionated at times but is easily convinced not to be.
  • Feel free to learn more about Yeoman.

License

Apache-2.0 © Kirill Scherba