Getting Started

The Mozilla Galaxy project is broken up into two components: the front end (galaxy) and the back end (galaxy-api). The front end is a single-page application that makes RESTful calls to the back end.

Installation

Front End

Clone or fork the front end repository galaxy (git@github.com:cvan/galaxy.git).

The front end framework being used is Mozilla Commonplace, the same framework that powers the Firefox Marketplace. Refer to the Commonplace wiki for documentation on usage of the framework.

# Install commonplace
$ npm install commonplace -g

# Copy local configuration into place
$ cp src/media/js/settings_local.js.dist src/media/js/settings_local.js

# Copy production configuration into place
$ cp src/media/js/settings_local_hosted.js.dist src/media/js/settings_local_hosted.js

# Start the server
$ damper

Back End

Clone/make a fork of the back end repository galaxy-api (git@github.com:cvan/galaxy-api.git).

We use a node.js server to serve HTTP requests and Redis for data persistence.

# Install redis via homebrew
$ brew install redis 

# Install node dependencies
$ npm install

# Copy local configuration into place
$ cp settings_local.js.dist settings_local.js

# Start the server
$ npm start

# Start the redis server
$ redis-server

If you'd like to run the server for development, consider using nodemon instead. Nodemon watches the files and automatically restarts the server when there are changes made.

$ npm install nodemon -g
$ nodemon app.js

After running the front end, back end and the Redis server, go to http://localhost:8675 to view Galaxy in action.