bookstrap

A HTML framework for making book apps.

npm install bookstrap
402 downloads in the last week
548 downloads in the last month

Bookstrap

Bookstrap is a HTML framework for making book apps.

See bookstrap.org.

Requirements

Bookstrap requires Node.js to be installed with npm. Node version >= v0.8.x is recommended.

Project set-up

npm install -g grunt-cli
npm install

Make sure grunt is installed globally and install the project dependencies.

Viewing the sample publication

grunt server

This will start a web server. The local web address is printed on the console.

Modifying CSS

Make sure you edit .less files only. To re-compile your LESS automatically, run the following command.

grunt watch

Building JavaScript and CSS for distribution

grunt build

This will generate files in the "dist" folder.

How to build for your device manually

Follow the Apache Cordova Getting Started guide for your platform. Once you have created your project, remove the www folder and replace it with www folder in this repository.

How to test in a web browser

Method 1: Use Chrome

  1. Launch Terminal
  2. Close Chrome if it is open already.
  3. Run the following command to run Chrome:
    /Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome --allow-file-access-from-files

4. Open index.html in Chrome

This will make sure Chrome can read local files using AJAX.

Method 2: Use a web server

Launch terminal and enter the following commands

cd your/path/to/bookstrap
grunt server

Open your browser at http://localhost:4000

Device support

See the Wiki page for further information.

Contributing

Click on "Issues" to report a bug or feature request. Pull requests are welcome.

Credits

License

Copyright (c) 2012 Contentment Ltd.

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.

npm loves you