inotebook v0.0.0

TBD

(...tbd)

1. Overview
2. Install
3. Run
4. Tests
   • Unit
     • Server
     • Client
   • Coverage
     • Server
     • Client
5. Contributing
   • Style Guide
     • JavaScript
6. License

Overview

The application uses Node.js, a server-side JavaScript engine, and Polymer, a framework for creating web components.

Installation

$ git clone https://github.com/kgryte/nodebook.git

Before running the application, install development dependencies

$ make install

which installs node modules and bower components.

Run

To start the application server

$ npm start

or, alternatively, from the top-level application directory

$ node ./bin/server.js

To view the application in your local web browser, navigate to

http://127.0.0.1:7337

Examples

...tbd.

Tests

Unit

To run units tests for both server- and client-side code,

$ make test

All new feature development should have corresponding unit tests to validate correct functionality.

Server

Server-side unit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command from the top-level application directory:

$ make test-server

Client

Unit tests are run via web component tester, which in turn uses the Mocha test framework with Chai assertions. To run the tests, execute the following command from the top-level application directory:

$ make test-ui

Test Coverage

This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command from the top-level application directory:

$ make test-cov

Istanbul creates a ./reports/coverage directory. To access HTML reports,

$ make view-cov

Server

To generate a test coverage report exclusively for server-side tests,

$ make test-server-cov

Istanbul creates a ./reports/coverage/server directory. To access an HTML version of the report,

$ make view-server-cov

Client

To generate a test coverage report exclusively for client-side tests,

$ make test-ui-cov

Istanbul creates a ./reports/coverage/ui directory. To access an HTML version of the report,

$ make view-ui-cov

Contributing

Style Guide

JavaScript

All JavaScript development, both client- and server-side, should follow the style guide.

CSS

...tbd.

License

MIT license.

Copyright

Copyright © 2015. Athan Reines.