Install Vagrant
Install VirtualBox
Clone this project
- Use One of the Following Programs
- Git Bash on Windows
- Terminal on Mac
- Shell on Linux
- Navigate to the vagrant folder in the cloned repository.
- Type the command vagrant up
- Type vagrant ssh to connect to the vagrant VM. (see below for setting up SSH on Windows)
Check the section Using the Vagrant Virtual Machine here for more information.
If you opt to use cmd.exe in Windows, you will be able to bring up the Vagrant VM. However, when you try to use "vagrant ssh" you will probably receive a message similar to the following:
`ssh` executable not found in any directories in the %PATH% variable. Is an
SSH client installed? Try installing Cygwin, MinGW or Git, all of which
contain an SSH client. Or use your favorite SSH client with the following
authentication information shown below:
Host: 127.0.0.1
Port: 2222
Username: vagrant
Private key: C:/Path/to/fullstack-nanodegree-vm/vagrant/.vagrant/machines/default/virtualbox/private_key
In the repository's subdirectory, vagrant/.vagrant/machines/default/virtualbox, there is a file called private_key
On Windows you can use the PuTTY Key Generator - PuTTYgen to convert the contents of that file into the *.ppk file you will use in PuTTY to ssh into the Vagrant/VirtualBox VM.
To convert the provided private_key file you will need to select "Import Key" under "Conversions"in PuTTY Key Generator. Specify the location of the "private_key" file and then click the "Save private key" button. When asked about saving the key without a passphrase, select yes. This will generate a private key file with the .ppk extension.
Once the file is saved you can then follow use the guide under the References SSH section.
Use the following configuration in PuTTY:
###Session
Host Name: 127.0.0.1
or localhost
###Connection -> Data
Auto-login username: vagrant
###Connection -> SSH -> Auth Private key file for authentication: Browse to the .ppk file you created using PuTTY Key Generator.
Once you've specified the above, go back to "Session" and under "Saved Sessions" enter a name for your config and click the "Save" button to the right of the list of Saved Sessions.
From this point on all you'll have to do to start the session is open PuTTY and double click on your config in the Saved Sessions list.
- Vagrant VM
- VirtualBox
- Clone of this Repository
- Sphinx
- flake8
sudo pip install Sphinx
sudo pip install flake8
##References
###Code Documentation
Documentation for the modules was generated using Docstrings and Sphinx.
###Code Formatting
Pep8 Online
An online python formatting tester.
Flake8
A Handy, command line tool for checking the formatting of your python code.
###Code Attributions
Most of my code was written using PostGreSQL Functions and Types that are in the tournament.sql file.
The queries and functions I created were combinations of techniques found in the links under the PostGreSQL section below.
###Other API and Coding References
Stack Overflow
A go to resource for solving all problems related to coding.
W3Schools
Great reference for all languages and specifications for programming web based content. HTML, CSS, jQuery, Javascript...
###PostGreSQL
PostGreSQL Docs
Return Multiple Fields in PostGreSQL
Return Setof Records
Store a Query Result in a Variable
Store Table Results from Two Queries, Columns
PostGreSQL CREATE FUNCTION return Types
Quick Guide to writing PLPGSQL Functions
psql Commands and Options
###SSH
How To Use SSH Keys with PuTTY and PuTTYGen
PuTTY for Windows
###Markdown
Online Markdown Editor
Incredibly useful for troubleshooting and learning markdown.
###License