ToTEM

ToTEM is a Flask app that allows users at Berea College to upload stories and images, which are then accessible via unique URLs and QR codes. This is a simple application for a project, and is not meant to be duplicated without adding security measures, or a different database to handle concurrency. It serves as a digital storytelling platform where items can be linked to digital information through the generated QR codes.

Tech Stack

• Backend Framework: Flask (Python)
• Database: TinyDB (Lightweight document-oriented database)
• QR Code Generation: Flask-QRcode
• Frontend: HTML5, CSS, JavaScript
• Package Manager: uv

Prerequisites

• Python 3.12+

• uv installed (Installation guide: https://docs.astral.sh/uv/getting-started/installation/)

  Sync dependencies: This command will create a virtual environment and install all locked dependencies.

  uv sync

Running the Application

To start the Flask development server:

uv run python app.py

Managing Dependencies with uv

• Add a new package:

  uv add <package-name>

• Remove a package:

  uv remove <package-name>

• Update packages:

  uv lock --upgrade

Hosting on server

Currently set up to port 5001. Server's firewall needs to allow incoming traffic to this port.

Students will need to be on the same wifi network.