Baboon Web Toolkit, modular fullstack web application framework for single-page realtime apps.
npm install baboon
|7||downloads in the last day|
|36||downloads in the last week|
|67||downloads in the last month|
|Version||0.3.6 last updated 2 days ago|
|License||The MIT License (MIT)|
|Keywords||single-page, realtime app, web application framework, web toolkit, fullstack web application framework|
|Dependencies (15)||async, cli-color, connect-redis, ejs, express, glob, log4js, log4js-node-mongodb, lx-helpers, lx-mongodb, lx-valid, pwd, redis, socket.io, nodemailer|
Baboon Web Toolkit - a modular fullstack web application framework for single-page realtime apps.
For quickstart and overviewing baboon, read the "Example app" section.
Getting started with the example app: Install global dependencies:
$ npm install -g grunt-cli karma bower
On Linux/Mac use administrative rights to install global modules:
$ sudo npm install -g grunt-cli karma bower
Clone the baboon repository and install the dev dependencies. Also install the dev dependencies for the example app. Build the example app and start the server with grunt.
$ git clone https://github.com/litixsoft/baboon.git $ cd baboon $ npm install $ cd example $ npm install $ bower install $ grunt server
Start the app running in your browser: http://localhost:3000. You can modify url settings in example/config/app.conf.json
grunt server builds the example application, starts the server and opens the the application in a browser. It then watch for changes in the directories. When making changes to files inside the
client/ directory, grunt only rebuilds the client files and reloads the site in the browser. When making changes to files inside the
server/ directory, grunt only restarts the server and reloads the site in the browser.
You can also start the
app.js manually. This is needed for debugging the app. Then you have to trigger the build by yourself. After each change do:
$ grunt build $ node app.js
Grunt nodejs scripts
Usually grunt tasks are started via console. In cases this can not easily been done, e.g. when using an ide like WebStorm, use the nodejs grunt scripts in the
scripts folder to start the tasks via nodejs.
You can run baboon unit tests and jshint with:
$ grunt test
You can run baboon unit tests, jshint and code coverage with:
$ grunt cover
You can also run baboon unit tests, jshint and code coverage for ci systems with:
$ grunt ci
It generates xml reports inside the build folder.
baboon example app
You can run all unit tests, e2e tests and jshint with:
$ grunt test
You can run jshint linter only with:
$ grunt lint
You can run all unit tests and jshint with:
$ grunt test:unit
You can run only the e2e tests with:
$ grunt e2e
Jshint and unit tests are using source files, e2e tests are using debug builds. You can also run e2e tests in release mode with:
$ grunt e2e:release
You can also run complete tests in release mode with:
$ grunt test:release
Tests will be aborted in case of an error. Use the --force option to skip abortion and continue testing, especially useful when jshint reports errors but you still want to run its e2e tests.
$ grunt test --force
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using grunt.
Roadmap for next releases
- complete rewrite the core
- e2e tests with protractor
Release publication dates
- 03/2013 0.4 stable
Copyright (C) 2013 Litixsoft GmbH email@example.com Licensed under the MIT license.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. DEALINGS IN THE SOFTWARE.