A web site for sharing literacy materials, especially templates for translation into minority languages.

---

Quick Start

Make sure you have Nodejs and then:

git clone  https://github.com/BloomBooks/BloomLibrary.git
cd BloomLibrary
sudo npm -g install grunt-cli karma bower  (on Linux)
npm -g install grunt-cli karma bower     ( on Windows)
npm install
bower install
grunt watch

(Currently bower asks you to choose between several versions of angular js, you should choose 1.0.8 which is typically choice 1. Also between versions of jquery...choose 2.0.3. Some specific versions are required because source files that our program references change locations or the name includes the version.)

Finally, open file:///path/to/bloomlibrary/build/index.html in your browser.

After pulling new releases, you may need to update various libraries. Do that with

npm update
bower update

About the grunt files

We built these using ngBoilerplate. Read the build.config.js file to see most of what is going on. See the readme of ngBoilerplate for more information. Here are key things:

Grunt merges many vendor and app-specific less files together into the bloom_xyz.css file. The list of these files is main.less. If you have a css file to load separately, list that in build.config.js.

Normally we have tests run via the offscreen browser phantomjs. If you want to debug using a normal browser, you'll find that setting in karma/X:\dev\BloomLibrary\karma\karma-unit.tpl.js.

Roadmap

see https://trello.com/b/eO6j48sf/bloom-library

Contributing

Books may be contributed to the website once we have it working. Code contributions are welcome also. We recommend interacting through the Trello board to be sure we're on the same track.

Copyright and License

Copyright 2013-2014 SIL International MIT/X11