Foxy-reminder: The Reminders App

A simple reminder app for the foxy.

• Python as the main programming language
• FastAPI for the backend
• HTMX 1.9.11 for handling dynamic interactions (instead of raw JavaScript)
• FastHX for htmx decorator
• TailwindCSS for css
• Jinja templates with HTML and CSS for the frontend
• TinyDB for the database
• Playwright and pytest for testing
• Ruff for format and linting
• Pre-commit for pre-commit hooks

Install

To install project dependencies:

# uv
uv pip install -r requirements.txt

# pip
pip intstall -r requirements.txt

Run

To run the app:

uvicorn app.main:app --reload

To load the app, open your browser to "http://127.0.0.1:8000"

Test

To run the tests:

pytest

Format and Lint

ruff format
ruff check

Logging into the app

The config.json file declares the users for the app. You may use any configured user credentials, or change them to your liking.

Setting the database path

The app uses TinyDB, which stores the database as a JSON file. The default database filepath is reminder_db.json.

Credits

• This project is inspired by Bulldoggy-reminder-app AutomationPanda.