Skip to content

LiamSchauerman/amber-elk

 
 

Repository files navigation

Stories in Ready Build Status

Amber-Elk: Into the Deep

A 3D Game

Team

  • Product Owner: Rishi Goomar
  • Scrum Master: Sean Rose
  • Development Team Members: Liam Schauerman, Tom G Varik

Table of Contents

  1. Usage
  2. Requirements
  3. Development
    1. Installing Dependencies
    2. Tasks
  4. Team
  5. Contributing

Usage

Coming Soon!

Requirements

  • Node 0.10.x
  • Gulp
  • Bower
  • NPM

Development

Installing Dependencies

From within the root directory:

npm install -g bower (or sudo npm install -g bower)
npm install -g gulp (or sudo npm install -g gulp)
npm install
bower install

Gulp Commands

Starting Development Server

# Run JSHint, Mocha Tests, then start the server
gulp

Generating Documentation

# Generates documentation under "/docs"
gulp docs

Running Tests and Generating Code Coverage

# Runs tests and generates code coverage of those tests in "/coverage"
gulp test

You should then see a docs/ folder which contains an easy to use documentation navigation system.

Roadmap

View the project roadmap here

Contributing

See CONTRIBUTING.md for contribution guidelines.

About

No description, website, or topics provided.

Resources

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • JavaScript 92.0%
  • CSS 8.0%