-
Download and install Vagrant.
-
Open a command prompt in the directory for this project. Run the following command to set up the virtual machine:
vagrant up
-
You can now start the server by running:
vagrant ssh -c "cd /vagrant && foreman start"
Instructions:
-
Ensure you have Python 3.4 installed. This can be checked at the command line:
$ python3 --version Python 3.4.0
If not, you can download it at the Python website.
-
Clone this repository with Git (download available at the Git website). The clone command should look like:
git clone https://github.com/malea/formaldatefinder.git
This will create a folder called
formaldatefinder
. -
Create a Python virtual environment in the project folder.
python3 -mvenv .
The environment can be activated using the following command:
source bin/activate
-
With the virtual environment active, run the following command to install the required packages.
pip install -r requirements.txt
-
Clone your version of the repository.
git clone https://github.com/YOURUSERNAME/formaldatefinder
-
Set the upstream to the original repository.
git remote add upstream https://github.com/malea/formaldatefinder.git
This allows you to update your master branch with the following command:
git pull upstream master:master
-
Develop in a separate feature branch. Create a new branch with:
git checkout master git checkout -b NEWBRANCH
Push your changes using:
git push origin NEWBRANCH:NEWBRANCH
-
Submit your changes for review as a Pull Request.