• app: the flask app
• db: database relative files
• diagrams: project diagram files
• env: vagrant environment files
• mockups: UI mockups and models (.psd files are to big too be shared)
• presentations: presentation files

Make sure you have a fast internet connection, you will be downloading something around 800Mb.

• Download Vagrant: https://www.vagrantup.com/downloads.html

• Install vagrant.

• Git clone this project.

• Open a shell, go to the env directory

• Run: vagrant up

• Wait for the installation process

###TA-DA!

Now you can access your server at the adress:

http://localhost:8080

The MySQL server is available at localhost:3306

######Some useful vagrant commands:

• vagrant up: lauches the virtual machine
• vagrant ssh: connects to the virtual machine through ssh
• vagrant reload: reloads the virtual machine
• vagrant halt: stops the virtual machine
• vagrant destroy: destroys the virtual machine

If you need to install something new to the virtual machine don't do it directly via ssh. Add the necessary commands to the vagrant/provisioning.sh file, destroy the VM and install it again. This way you can commit and share the exact same environment with everyone else.

If you have something working, that you can show, even if it is not finished and every other changes from the others are well integrated with yours, you can push it into "master". When everybody agreed on the changes we can push it into "final". At the end, we can push it in "prod"

When you are working and testing, use your OWN branch !

To create a branch : git checkout -b NomDeLaNouvelleBranch
To switch to another branch : git checkout LaBranche

To merge a branch into another :

git checkout laBranchDansLaquelleOnVeutMerger
git merge laBrancheAMerger

##Have fun :)