Skip to content

Latest commit

 

History

History
58 lines (36 loc) · 2.27 KB

README.md

File metadata and controls

58 lines (36 loc) · 2.27 KB

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

You will need to develop using a local web server (see Setting Up Your Development Environment -> Server).

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. Code contributions are welcome also. We recommend interacting through the Trello board to be sure we're on the same track.

Search Engine Optimization

A problem with the current approach is that Google and other web crawlers don't see anything more than our home page. This is discussed at length at https://docs.google.com/document/d/1XAJRmQoJHYkwkf4CVW_OWiBkRT1jqufKF2rJajcnxIw/edit?usp=sharing.

SIL Build Agent Setup

AWS Credentials

The credentials needed to upload the content to the S3 bucket must be supplied in the AWS credential store. On current agents, this can be found at c:\users\bob\.aws\credentials. When running the build, pass the profile name as the ProfileName parameter of the Upload target.

Install on machine

7zip must be accessible in the PATH.

Copyright and License

Copyright 2013-2018 SIL International MIT/X11