Contact Information

Project 2

Name	Position	Username	Email	Phone
Zachary Belloma	Architect / Developer	zbelloma	[email protected]	???
Tyler Cobb	Project Manager	Tcobbs72	[email protected]	612-963-1237
William Park	Systems Engineer	wipark93	[email protected]	???
Brian Simons	Quality Control	brnsmns13	[email protected]	319-651-0782

Project 3

Name	Position	Username	Email	Phone
Tyler Cobb	Systems Engineer	Tcobbs72	[email protected]	612-963-1237
Robert Kloster	Project Manager	RobertKloster	[email protected]	515-720-5986
William Park	Quality Control	wipark93	[email protected]	???
Branden Lange	Tester & Integrator	CivBase	[email protected]	515-975-7491
Brian Simons	Architect / Developer	brnsmns13	[email protected]	319-651-0782

Resources

Project 2

• Team Documents

Development Tools

• draw.io - Flowchart and UML diagram creation web application
• Git - Version control system
• PyCharm - Python interactive development environment

CSS

• Bootstrap - CSS style framework

Javascript

• jQuery - Library for DOM querying and AJAX requests
• NPM - Javascript package manager (part of NodeJS)

Python

• Google App Engine - Web server framework
• Jinja2 - HTML templating language for python
• pip - Python package manager
• webapp2 - Web server library/framework

Configuration

Git Setup

1. Download and install Git from here. Make sure you allow the installer to add Git to your system path!
2. Open Git Bash and navigate to the directory where you want your project directory to be located (I recommend ~/workspace) and clone the repository with git clone https://github.com/brnsmns13/se329.git or git clone [email protected]:brnsmns13/se329.git if you have SSH key set up. Setting up SSH keys will allow you to avoid typing in your password every time you push/pull, but it is not necessary.
3. From within your project directory (e.g. ~/workspace/se329) configure Git to use the correct user with git config user.name <username> and git config user.email <email>. Be sure to use the same username and email as you use for your GitHub account.
4. Check out these Using Git and GitHub instructions for more information.
5. Check out COMMANDS.md for more information on git commands.

Python Setup

1. If you're on Windows, install Git first. I have found that Git's Git Bash terminal is much easier and more convenient than Command Prompt or Power Shell because of its Git, virtualenv, and bash support. All of my Windows instructions depend on you using Git Bash, so you may need to get creative otherwise.
2. Download and install Python 2.7 from here. It is important to get Python 2.7 and not Python 3.4.
3. Download and install the python package manager "pip" from here. If you have Python 2.7.9 or higher, pip will already be installed with python and this step can be skipped.
4. Add python and pip to your "Path" system environment variable. On Windows, open the system environment variables dialog and, for a standard Python 2.7.9 installation, you can just append ;C:\Python27\;C:\Python27\Scripts to the end of the existing value (restart any terminals for it to take effect). On a UNIX machine, just add the lines export PATH="/Library/Frameworks/Python.framework/Versions/2.7/bin:$PATH" and export PATH="/Library/Frameworks/Python.framework/Versions/2.7/bin/pip:$PATH" to your ~/.bash_profile file (restart any terminals for it to take effect).
5. Install the virtualenv package using pip install virtualenv. This package allows you to create virtual environments, which make package management between projects easy. Without an active virtual environment, your python packages are added to your base system installation of python, which is messy and dangerous on Linux machines. For more on virtualenv, check this out.
6. Create a virtualenv directory (I recommend ~/virtualenvs) and, from within that directory, create a new virtual environment for this project with virtualenv quiz. Activate the new environment from this directory with source quiz/bin/activate or source quiz/Scripts/activate on Windows. Always make sure your environment is activated when installing packages (pip install <package_name> or pip install -r <file> when installing from a text file). The virtual environment can be deactivated any time with deactivate.
7. Check out COMMANDS.md for more information on python and pip commands.

On a UNIX machine, I recommend putting an alias like this in your ~/.bash_profile file so that you can activate your virtualenv from anywhere with the quiz command.

alias quiz="cd ~/workspace/quiz && source ~/virtualenvs/quiz/bin/activate"

For Windows users, you can do something similar by creating the file ~/quiz.bat and adding the below code. Activate it from anywhere with source ~/quiz.bat in Git Bash.

source ~/virtualenvs/quiz/Scripts/activate
cd ~/workspace/quiz

Requirements

1. With your virtualenv activated, navigate to the quiz (root) directory.
2. Install all pip requirements with pip install -r requirements_dev.

App Engine Setup

1. Download and install the App Engine SDK form here.
2. Startup the newly-installed App Engine Launcher application and click the add button (plus icon in the bottom left).
3. Choose the se329 (root) project directory and click the "Create" button to add it to your list (it is named better-than-clickers-quiz-app).

Execution

1. Open the App Engine Launcher, select the better-than-clickers-quiz-app application and then click the big green "Run" button in the top left of the window.
2. Click the "Browse" button at the top of the launcher window to open the app in your browser.

Contributing

1. Do not push directly to the repository. Instead, create a fork using the "Fork" button at the top-right of the repository page.
2. Add the fork to your local workspace by navigating to the project directory and using the command git remote add <fork_name> <fork_https>. The fork name can be anything, but I prefer to use my own name. By using names, I can easily add remotes to access other forks and easily distinguish between them. The fork https url can be found on the fork's GitHub page.
3. Use git push <fork_name> <branch_name> to push branches to your fork. From there, you can create a pull request onto master in the "origin" repository. This allows us to review contributions and keep track of all changes.

Note: All code used by this project should conform to pep8 standards. It seems trivial, but formatting standards make large-scale development much easier, so please try to adhere to it. PyCharm will automatically notify you of any lines which do not adhere to pep8 standards in the bar on the right of the editor.