learnforward-author is a build tool for generating HTML5 textbooks
npm install lfa
|2||downloads in the last day|
|6||downloads in the last week|
|84||downloads in the last month|
|Version||0.4.12 last updated 2 days ago|
|Keywords||textbook, development, build, tool|
|Dependencies (23)||minimatch, js-yaml, monocle, async, stylus, jade, marked, clean-css, uglify-js, snockets, mkdirp, q, coffee-script, connect, faye-websocket, open, readdirp, underscore, colors, shelljs, update-notifier, optimist, autoprefixer|
LearnForwardAuthor is a build tool for generating HTML5 textbooks. Application structure and functionality is heavily inspired by roots.
Make sure you have node.js installed, then just run
npm install -g lfa. If you get permission issues asking you to re-run the command with
sudo, you most likely have a dodgy node installation. You can probably circumvent it temporarily with
sudo -H npm install -g lfa.
LFA is a command line tool. Run
lfa in your terminal for the basic help.
LFA has two separate test suites: one deals with the build tool, the other deals with the functionality and visuals of the generated textbooks.
The build tool tests are located in
/vagrant/test/ and can be run either through
mocha (you'll have to install it globally) or by running
npm test in the project root folder. Reading through
test.coffee is also a good way to get a feel for what we expect the tool to be able to do; like compiling, moving files from one folder to the other, generating a table of contents from a particular folder structure and so on.
The textbook tests are located in
/vagrant/patterns/test/ and run through the same
npm test command, but this time from the
patterns/ folder. It's a PhantomCSS test suite that runs a headless Chrome browser within the Ubuntu virtual machine in vagrant. It prods around the textbook, clicks various things and takes screenshots of the application in its varying states and screen sizes.
While it is possible to run the build tool tests from outside the vagrant virtual machine to get faster suite speeds, because the visual regression PhantomCSS tests take actual screenshots of the page they would be invalidated if you ran them from a different operating system with different font rendering.
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.