Installation Instructions

This page describes how to set up a use-case or the main repo and how to configure your environment variables.

Cloning the repo

GUI (Gitkraken)

Cloning

Clone the repository to a folder you like, here you can see that I'm cloning the helpers repository into my farm2 folder.

Now navigate to your directory in a terminal/command line interface and afterwards go to the tab on the top of this page to install your pip packages.

cd /media/selene/Code/Git/farm2/<repo_name>

Use Case Repo's

Main Repo

CLI Cloning

Casus Repo's

git clone https://github.com/BB8-2020/<repo_name>
cd ./<repo_name>

pip install .

Main Repo

Setting up your environment variables

A helper repository has been created with a couple shell/batch scripts to automate the process of changing your environment variables. The following code shows how to use them.

Windows

To set environment variables on windows please have a look at: superuser.stackexchange.com

Please initially set your ENV variables manually to:

1. FLASK_APP = "sandbox.py"

2. FLASK_ENV = "development"

The following commands will temporarily (until you relaunch cmd) set your environment variables to the appropriate repo.

Casus Repo's

git clone https://github.com/BB8-2020/helpers

# Navigate to the windows folder
cd ./helpers/windows

# Export the use-case (sandbox) environment
export_sandbox.bat

Main Repo

Linux / OSX

On Linux / OSX your FLASK_ENV and FLASK_APP will be saved to your .bashrc and will persist across sessions.

Casus Repo's

git clone https://github.com/BB8-2020/helpers

# Navigate to the unix folder
cd ./helpers/unix

# Export the use-case (sandbox) environment
source ./export_sandbox.sh

Main Repo