Personal Website

Flask App powered personal website

Installation

The main system dependencies are Python its development packages.

1. Python virtual environment and dependencies

It's probably a good idea to create a virtual environment for this project

Then, clone the repo, cd into it, and create a project virtual environment.

git git@github.com:Piusdan/Piusdan.github.io.git
cd Piusdan.github.io
python3 -m venv venv
source venv/bin/activate

Once you have the virtual environment installed on your system, and the system dependencies, the rest is simple:

pip install -r requirements.txt

Configuration

• Copy .env_example into a new file .env at the root of the project folder.
• Update .env with your development environment information.

Run

• To start the flask development server: python app.py.

Tests

• TODO Add documentation

Contributing

Use gitflow. Kindly always tag releases to develop and master.

Deploying

Ansible is used for deployment, so you should install that first on your machine. See the installation instructions. For deployments to prod, make sure all changes are tested and working. Preferably, do a canary release first if possible.

• Create a hosts files and update your hosts variables

touch playbooks/deploy/hosts.ini

• Run Deployment commands:

  cd playbooks/deploy

  ansible-playbook playbook.yml -i hosts.ini (-l [SERVER_GROUP]) --tags "deploy" e.g ansible-playbook playbook.yml -i hosts.ini -l prod_app_servers --tags "deploy" ansible-playbook playbook.yml -i hosts.ini -l test_app_servers --tags "deploy"

If you need to setup the app on a new server, add the setup tag to the role.

   ansible-playbook playbook.yml -i hosts.ini (-l [SERVER_GROUP]) --tags "setup,deploy"

You might also need to request for one or more group_vars files, which contain sensitive information such as passwords. Once you receive it, copy them to the playbooks/deploy/group_vars folder.