This is the source code for the "Glean for good" application

To get you started you can simply clone the Glean repository and install the dependencies:

You need git to clone the Glean repository. You can get it from http://git-scm.com/.

Clone the Glean repository using git:

git clone https://github.com/gleanforgood/glean.git
cd glean

We have two kinds of dependencies in this project: tools and framework code. The tools help us manage and test the application.

• We get the tools we depend upon via npm, the node package manager.
• We get the angular code via bower, a client-side code package manager.

We have preconfigured npm to automatically run bower so we can simply do:

npm install

Behind the scenes this will also call bower install. You should find that you have two new folders in your project.

• node_modules - contains the npm packages for the tools we need
• app/bower_components - contains the angular framework files

Note that the bower_components folder would normally be installed in the root folder but angular-seed changes this location through the .bowerrc file. Putting it in the app folder makes it easier to serve the files by a webserver.

We have preconfigured the project with a simple development web server. The simplest way to start this server is:

npm start

Now browse to the app at http://localhost:8000/app/index.html.

There are two kinds of tests : Unit tests and End to End tests.

Unit are written in Jasmine, which we run with the Karma Test Runner. We provide a Karma configuration file to run them.

• the configuration is found at test/karma.conf.js
• the unit tests are found in test/unit/.

The easiest way to run the unit tests is to use the supplied npm script:

npm test

This script will start the Karma test runner to execute the unit tests. Moreover, Karma will sit and watch the source and test files for changes and then re-run the tests whenever any of them change. This is the recommended strategy; if your unit tests are being run every time you save a file then you receive instant feedback on any changes that break the expected code functionality.

You can also ask Karma to do a single run of the tests and then exit. This is useful if you want to check that a particular version of the code is operating as expected. The project contains a predefined script to do this:

npm run test-single-run

npm start

In addition, since Protractor is built upon WebDriver we need to install this. The Glean project comes with a predefined script to do this:

You can update the tool dependencies by running:

npm update

This will find the latest versions that match the version ranges specified in the package.json file.

You can update the HTML dependencies by running:

bower update

This will find the latest versions that match the version ranges specified in the bower.json file.

The project comes preconfigured with a local development webserver. It is a node.js tool called http-server. You can start this webserver with npm start but you may choose to install the tool globally:

sudo npm install -g http-server

Then you can start your own development web server to serve static files from a folder by running:

http-server

Alternatively, you can choose to configure your own webserver, such as apache or nginx. Just configure your server to serve the files under the app/ directory.

Assets and other working documentation can be found here.

For more information on Glean please contact [email protected]