Getting Started Guide for New Team Programmers

This guide is intended to be a summary of the March 16th meeting to bring new programmers up to speed, plus some additional information to help get started.

---

Code Location/Summary

• Code can be found here.
• Split into 3 sections: node, rails, and resources
  • node: used to push real-time changes to client
  • rails: a ruby on rails project (users will point their browsers to this project's page to play the game)
  • resources: a cakePHP project used to provide resources, including the game's js code, for the rails server
• "master" branch is our main branch for current code, "OLD-PHP-API" is an older version of the code included for reference.
• You can find a summary and diagram of the code setup here.

Getting Set Up

• Install git and create a github account if you haven't already
• For Windows users, Github for Windows provides an easy to use interface for interacting with github
• Install Ruby and Rails to run the code in the rails directory
  • Ruby on Rails Tutorial and Install Guide
  • Ruby Stack bundles ruby, rails, git, and other useful tools to get started with Ruby on Rails.
• Install WAMPserver to run the code in the resources directory
  • Uncomment the line in httpd.conf that starts with "LoadModule rewrite_module".
  • Skype has an option to use port 80, which can interfere with WAMPserver - be sure to disable this if you want to use skype while running the server.
• Install PostgreSQL
  • If you run into trouble using the installer for windows, try setting up manually from the zip file using this guide
  • Use the rails db config file to get the username/password (use development environment setting)
• You may need to download cakePHP's code to get the resources project running. You can combine this with the resources code in two ways:
  • Copy everything from cakePHP into the directory used by WAMPserver, then copy from the resources directory, overwriting for any conflicts.
  • Copy everything from the resources directory into the WAMPserver directory, then copy from cakePHP without overwriting anything .

Using Mewars' github project

• Send Ryex your github account's email and ask him to add you as a contributor to the project.
• When making changes to code, small changes can be committed and pushed to master. Larger changes should use a new branch to be merged back into master when finished.
• Issues
  • Issues are marked "enhancement" or "bug", among several other options (listed on the left of the issues page).
  • Clicking on the name of an issue will take you to a description of the issue, and what specific changes need to be done to complete it.
  • Once you are added as a contributor to the project, you can assign issues to yourself (or others), though you may want to discuss with Ryex and the rest of the team when taking on an issue.
  • The wiki provides an overview and details of the project, and is a great way to begin getting familiar with the project.

Javascript Code

• Can be found here
• The javascript code makes use of Crafty JS
• Split into two subdirectories: Boot and Include
  • Boot has code to start up the game
  • Include files gets loaded from the Boot code