Github reader

This is a small sample application for reading Github repositories implemented in AngularJS.

The application is based on angular-seed, an AngularJS skeleton containing everything to start a project from scratch.

Getting Started

To get you started you can simply clone the angular-seed repository and install the dependencies:

Prerequisites

Checkout this repository using git.

You must also have node.js and its package manager (npm) installed. You can get them from http://nodejs.org/.

Install Dependencies

The project inherited two kinds of dependencies from the angular-seed skeleton: tools and angular framework code. The tools help us manage and test (not implemented) 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.

The guys from angular.seed 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.

Run the Application

The project is orecinfigured 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.