vtes-archon 0.2

VTES tournament management

archon

Tournament management

Development install

This project uses npm, that you can install with nvm. It also uses Python on the backend side, so install Python version >= 3.11.

Finally, you'll need GNU Make for simple targets and processes defined in a Makefile. Four options if you are on Windows:

• Use Chocolatey as package manager and choco install make
• Use the Windows Subsystem for Linux (WSL) feature
• Just install the GNU make binary for Windows
• Don't use make at all. The Makefile is just a shortcut, you can open it and copy/paste the commands in your Powershell.

nvm install node
nvm use node
python -m virtualenv .venv
source .venv/bin/activate
make update

We are using a couple of very standard tools and frameworks, that make update will install and update for you:

• Typescript our frontend language

• Bootstrap and its icons, for basic styling & responsiveness

• Parcel as our build framework for frontend

• FastAPI as our backend server framework, with Jinja2 for HTML templating, and its i18n extension for potential future translations

• PostgreSQL for database, with psycopg3 as our library to instrument it

• Black and Ruff for python formatting and linting, respectively

• Twine to publish our Python package to the public PYPI repository.

• PM2 to run our hot reload development services (front & back)

• Geonames for countries and cities names and IDs

• Typer for the archon Command-Line Interface (CLI)

Make targets

• make geodata downlad and refresh the geographical data in geodata
• make test runs the tests, formatting and linting checks
• make serve runs a dev server with watchers for auto-reload when changes are made to the source files
• make clean cleans the repository from all transient build files
• make build builds the python package
• make release creates and pushes a git tag for this version and publishes the package on PYPI

CLI

The archon CLI gives access to useful DB-related commands when developing in local.

> archon --help

 Usage: archon [OPTIONS] COMMAND [ARGS]...
╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --install-completion          Install completion for the current shell.                                         │
│ --show-completion             Show completion for the current shell, to copy it or customize the installation.  │
│ --help                        Show this message and exit.                                                       │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ──────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ list                                                                                                            │
│ reset-db                                                                                                        │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

Development database

You need a running PostgreSQL server, with an archon superuser, an archon database owned by that superuser, with no password. You can use the DB_USER and DB_PWD environment variables to use other values. The database name is not configurable.

Development server

Simply use make serve to run the front and back services. They constantly watch your files and rebuild the project automatically when there is any change. Use pm2 logs to keep an eye on what's going on and pm2 kill to stop the services. You can also use pm2 ps to check if the services are up and running. For more, see the PM2 documentation.