CSCE 431 Workflow Setup

Install Software

There are a few required pieces of software in order to get the workflow set up correctly.

Git

version control system

1. Go to http://git-scm.com and download the latest Git release for your system
2. Run the installation
3. You might also wish to install a Git user interface.

Some programs might expect the Git executables to be in your system's PATH environment variable. On OS X and Linux, this step is not necessary, but on Windows (unless Cygwin is being used to install the software), please follow these instructions:

1. Go to Start, right-click on Computer, and choose Properties
2. Under the Advanced Tab, click Environment Variables...
3. In the System variables list, find and select Path, then click Edit...
4. Append a semi-colon (;) at the end of the Variable value field's contents. This serves to separate the other system paths from the one we are about to add.
5. Append the path to your Git installation's bin directory (usually C:\Program Files (x86)\Git\bin, but verify this on your system first).
6. Click OK to close the Edit System Variable window.
7. Click OK to close the Environment Variables window.
8. Click OK to close the System Properties window.

Node.js

Chrome's V8 JavaScript runtime written as a command-line executable (similar to how Python works). This will be needed to install and run Bower.

1. Go to http://nodejs.org and download the latest Node.js release for your system
2. Run the installation

You may wish to add node and npm to your system's PATH environment variable. Please follow the instructions above, but use the path to your Node.js executables instead (usually C:\Program Files\Nodejs, but verify this on your system first).

Bower

Dependency (and package) management system for client-side scripts. This will install the bower Node.js module globally on the system as a command-line executable. (By default, Node.js places modules in a node_modules folder in the current working directory

1. Open the Node.js command prompt (or just a standard command prompt if you added npm to your PATH)
2. Execute npm install -g bower

Grunt

We use Grunt, a Node.js NPM module to handle some of our build process. In particular, theme stylesheets are specified in the LESS stylesheet language (a superset language of CSS) and must be compiled from *.less files into a single *.css file for distribution.

1. Open the Node.js command prompt (or just a standard command prompt if you added npm to your PATH)
2. Execute npm install -g grunt-cli

Install RSA Keys

I have generated keys for all team members. Please contact me to get your public/private RSA key pair. These keys will need to be placed in the .ssh folder in your user's home directory and renamed to id_rsa and id_rsa.pub, respectively.

Clone Repository

1. Open your preferred Git client
2. Clone the repository location git@git.komputerwiz.net:edu/tamu/csce-431.git
   • The command-line way to do this is git clone git@git.komputerwiz.net:edu/tamu/csce-431.git
   • If your client does not like the provided SSH shorthand format above, try ssh://git@git.komputerwiz.net/edu/tamu/csce-431.git
3. If you have trouble cloning the repository due to permissions errors, please let me know

Setting up the Project

1. Open a Git Bash command prompt (or just a standard command prompt if you added git to your PATH) and navigate to the repository location.
2. Run bower install

Building

1. Open a Node.js command prompt (or just a standard command prompt if Node.js is on your PATH) and navigate to the project repository location.
2. Run grunt build