Snack Attack Track

Snack Attack Track is a subscription/membership management software meant to run on a raspberry pi with a touchscreen.

Setup development environment

Tip

If you are trying to follow these steps for the first time, PLEASE let us know if you run into any problems so we can update the setup process

Windows

Prerequisites

1. Python 3.9 (preferably installed from the Microsoft store)
2. git

Recommended dev-tools

1. GitHub Desktop (if you prefer GUI for git)
2. Visual Studio Code

Installation

Clone the repository either with GUI or following terminal commands

git clone https://github.com/DouglasHalse/snackAttackTrack.git
.\setupDevEnvironmentWindows.bat

Start GUI with debugging (with Visual Studio Code)

1. In Visual Studio Code: Select File > Open Folder... and select the cloned repository
2. Hit ^ Ctrl + ⇧ Shift + P and write select interpreter and click Python: Select Interpreter
3. Select the Python executable found in venv/Scripts/python.exe
4. Hit F5 to start debugging with the preset Python: Run Snack Attack Track GUI

Start GUI without debugging

Run runGuiWindows.bat

Linux

Prerequisites

1. Python 3.9 or Python 3.10

Recommended dev-tools

1. GitKraken Client if you prefer GUI for git
2. Visual Studio Code

Installation

Clone the repository either with GUI or following terminal commands

git clone https://github.com/DouglasHalse/snackAttackTrack.git
bash setupDevEnvironmentUbuntu.sh

Start GUI with debugging (with Visual Studio Code)

1. In Visual Studio Code: Select File > Open Folder... and select the cloned repository
2. Hit ^ Ctrl + ⇧ Shift + P and write select interpreter and click Python: Select Interpreter
3. Select the Python executable found in venv/bin/python
4. Hit F5 to start debugging with the preset Python: Run Snack Attack Track GUI

Start GUI without debugging

1. Run bash runGuiUbuntu.sh in a terminal

Debugging gui layouts

1. Press ^ Ctrl + E to start kivy inspector

Pre-commit

This will run pylint and black to format the code and check for any violations of the PEP 8 Python coding standards.

pip install black pylint pre-commit
pre-commit install
pre-commit run -a