Skip to content

Latest commit

 

History

History
74 lines (45 loc) · 2.9 KB

README.md

File metadata and controls

74 lines (45 loc) · 2.9 KB

Blackout Rugby

This is the ember.js app for Blackout Rugby. The live app can be found at https://v2.blackoutrugby.com.

Be warned that this version is in heavy development. Changes are being made often, directly to the Master branch (for now). If you would like a copy which is guaranteed to be working, please checkout one of the releases during install.

If you have any trouble or just want to chat, feel free to contact us. We'd love to hear from anyone interested in developing for Blackout Rugby.

Ember 101

If any of the below is new to you. The best place to start is to read through the Ember CLI E-book. This will give you a solid understanding of ember.js. After you've been through the book, come back here to continue.

Prerequisites

You will need the following things properly installed on your computer.

Installation

In terminal/command prompt:

  • git clone https://github.com/blackout-games/rugby.git
  • cd rugby
  • npm install
  • bower install

Environment

You'll need to make some changes to config/environment.js to suit your local setup.

  • Uncomment var localIP = 'localhost';
  • Uncomment the block containing Development API (Live, Production) to ensure you'll be connecting to the Live API.
  • Comment out other variables/blocks of the same name.

Code accuracy

Make sure you're using jshint in your code editor, this will show you any syntax imperfections. We recommend Sublime Text with the Sublime​Linter-jshint package.

Running / Development

Code Generators

Make use of the many generators for code, try ember help generate for more details

Deploying

You will not be deploying Blackout Rugby. You can make changes and submit pull requests, then we will deploy to production.

API

The API documentation can be found here. If you need any changes please create a new issue.

Further Reading / Useful Links

Licensing

© 2015-Present
Blackout Entertainment Limited (NZ)
All Rights Reserved

If you are interested in licensing the app for a new sport, please contact us.