Pyrom

python/flask port of porom

this is now the canonical implementation of porom

License

Released under CNPLv7+. Please read the full terms for proper wording.

installing & first time setup

docker (production)

create config/secrets.prod.env according to config/secrets.prod.env.example

$ docker compose up

opens port 8080
exposes data/db and data/static for data backup and persistence

make sure to run it in an interactive session the first time, because it will spit out the password to the auto-created admin account.

manual (development)

install python >= 3.13, sqlite3, libargon2, and imagemagick & clone repo
create a venv:

$ python -m venv .venv
$ source .venv/bin/activate

install requirements:

$ pip install -r requirements.txt

run dev server:

$ python -m app.run

the server will run on localhost:8080. when run for the first time, it will create an admin account and print its credentials to the terminal, so make sure to run this in an interactive session.

press Ctrl+C to stop the server.

to deactivate the venv:

$ deactivate

when you want to run the server again, make sure to activate the venv first:

$ source .venv/bin/activate
$ python -m app.run

icons

the icons in the data/static/misc/ folder are by Gabriele Malaspina

1.5 KiB Raw Blame History