IACL - an Imperial Assault Campaign Logger

This project is an campaign logger for [Fantasy Flight's Imperial Assault] (https://www.fantasyflightgames.com/en/products/star-wars-imperial-assault) board game. I'm using it for two purposes. Firstly to create an easy to use webbased campaign log for that game. And secondly to educate myself on building dynamic webapps with AngularJS and Twitter Bootstrap.

Disclaimer

This tool is unofficial and is not affiliated with Fantasy Flight Games, Lucasfilm Ltd., or Disney.

Contributing

If you want to contribute or help me getting used to building webapps, feel free to contact me via github

Getting Started

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

Prerequisites

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

I also use a number of node.js tools to initialize and test this app. You must have node.js and its package manager (npm) installed. You can get them from http://nodejs.org/.

Clone IACL

Clone the repo repository using git:

git clone https://github.com/bknobloch/iacl.git
cd iacl

Install Dependencies

We have two kinds of dependencies in this project: tools and angular 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 I changed 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

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.

Directory Layout

app/                    --> all of the source files for the application
  controller/           --> all app specific AngularJS controllers
  service/              --> all app specific AngularJS services
  app.css               --> default stylesheet
  app.js                --> main application module
  index.html            --> app layout file (the main html template file of the app)
  index-async.html      --> just like index.html, but loads js files asynchronously
karma.conf.js         --> config file for running unit tests with Karma
e2e-tests/            --> end-to-end tests
  protractor-conf.js    --> Protractor config file
  scenarios.js          --> end-to-end scenarios to be run by Protractor

Testing

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

Running Unit Tests

The app comes preconfigured with unit tests. These 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 karma.conf.js
the unit tests are found next to the code they are testing and are named as ..._test.js.

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

End to end testing

The app comes with end-to-end tests, again written in Jasmine. These tests are run with the Protractor End-to-End test runner. It uses native events and has special features for Angular applications.

the configuration is found at e2e-tests/protractor-conf.js
the end-to-end tests are found in e2e-tests/scenarios.js

Protractor simulates interaction with our web app and verifies that the application responds correctly. Therefore, our web server needs to be serving up the application, so that Protractor can interact with it.

npm start

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

npm run update-webdriver

This will download and install the latest version of the stand-alone WebDriver tool.

Once you have ensured that the development web server hosting our application is up and running and WebDriver is updated, you can run the end-to-end tests using the supplied npm script:

npm run protractor

This script will execute the end-to-end tests against the application being hosted on the development server.

Updating Dependencies

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 app dependencies by running:

bower update

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

Contact

You can contact me via github any time.

bfassbender/iacl