tmdinosaurcenter/kiosk-guestbook
1
0
Fork 0
mirror of https://github.com/tmdinosaurcenter/kiosk-guestbook.git synced 2025-04-10 14:11:28 -06:00
Code Issues Packages Projects Releases Wiki Activity

Updated the project structure to reflect the current structure.

Browse Source
This commit is contained in:
Steve Dogiakos 2025-04-01 22:09:54 -06:00
parent a16b28d078
commit 320e358aa6
1 changed files with 17 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -18,14 +18,23 @@ Uses Docker and Docker Compose to create a production-ready environment with Gun
## Project Structure ## Project Structure
``` ```
kiosk-guestbook/ kiosk-guestbook/
├── app.py # Main Flask application with logging, validation, and database initialization ├── scripts/
├── requirements.txt # Python dependencies (Flask, Gunicorn, etc.) │ ├── guestbook_export.py # Script to export guest entries (e.g., for Mailchimp)
├── Dockerfile # Production Dockerfile using Gunicorn │ └── guestbook.db # SQLite database file (if stored here, mainly for development)
├── docker-compose.yml # Docker Compose configuration for container orchestration ├── static/
├── .env # Environment variables file (see template below) │ └── images/
├── en.txt # Profanity list file (banned words, one per line) │ └── logo.png # Logo for display in the application
└── templates/ ├── templates/
└── index.html # HTML template for the guestbook user interface │ └── index.html # Main HTML template for the guestbook
├── .env # Environment variables for Docker Compose (production settings)
├── app.py # Main Flask application code
├── docker-compose.yml # Docker Compose configuration for container orchestration
├── Dockerfile # Default Dockerfile (development or general usage)
├── en.txt # Profanity list file (one banned word per line)
├── production.Dockerfile # Optional Dockerfile optimized for production
├── README.md # Project documentation
└── requirements.txt # Python dependencies (Flask, Gunicorn, etc.)
``` ```
## Getting Started ## Getting Started
Prerequisites Prerequisites