container-critique/README.md

Container Critique

Container Critique is a blog based on Pythons Flask framework. The blog is intended to be used to review and critique movies, books and similar media.

Features

• User Management

  • Registration
  • Login
  • Logout
  • User profile page

• Blog Functionality

  • Create entries
  • Edit entries
  • Delete entries
  • Standalone article pages
    • Links back to main blog page
  • Infinite-scroll main page
  • Archive page
    • Monthly grouping
    • Links to main blog page
    • Links to standalone articles

• Search

  • Full-text search

• Syndication

  • RSS feed

• User Interface

  • Responsive navigation
    • Header
    • Footer
  • Rich text editor
  • Star ratings
  • Styling for common HTML tags
  • Theme support
    • Dark theme
    • Light theme
  • Logo

• Deployment

  • Basic Python
  • Docker

To-Dos

• Quality of Life Improvements
  • Improved UI for writing entries
  • Improved UI for editing entries
  • Improved UI for deleting entries
  • Improved UI for login flow

Usage

Deployment

uv (Recommended Over PIP)

• install uv
• git clone https://github.com/tiyn/container-critique
• cd container-critique
• install the dependencies with uv sync
• edit the src/config.py file according to your needs
• run uv run python src/app.py
• blog is available on port 5000

PIP/Python

• git clone https://github.com/tiyn/container-critique
• cd container-critique/src
• edit the config.py file according to your needs
• install dependencies with pip install -r requirements.txt
• run python app.py
• blog is available on port 5000

Docker

Make sure you copy an example config.py and edit it before running the container. The config.py can be found in the src folder.

Volumes

Set the following volumes with the -v tag.

Volume-Name	Container mount	Description
config-file	/blog/config.py	Config file
data	/blog/data	Directory for data
css	/blog/static/css	(optional) Directory for css files

Ports

Set the following ports with the -p tag.

Container-Port	Recommended outside port	Protocol	Description
5000	80	TCP	HTTP port

Example run-command

An example run command is shown in rebuild.sh.