Good Girl

A basic pet-play themed multi-user webapp to provide a framework of earning rewards when completing set tasks, allowing tasks to be managed by a trusted owner.

---

To get started, copy config.yaml.sample into config.yaml and set your database secret.

cp config.yaml.sample config.yaml

To start a development server, use uv:

uv run flask run --debug

Config File Parameters

Parameter	Type	Explanation
title	String	Title of your webapp
footer	String	Footer text inserted at the bottom of the page
pet_title	String	Title to use for the managed role (e.g. Pet, Worshipper, Pilot)
pet_plural	String	Pluralised version of above
owner_title	String	Title to use for the manager role (e.g. Owner, Goddess, Handler)
owner_plural	String	Pluralised version of above
disable_registration	Boolean	Set true to disable new sign-ups
db_secret	String	A random string to keep client-side sessions secure

Example provided in config.yaml.sample.