Overview

This documentation site captures technical documentation for Gyrinx.

Gyrinx is a Django application running in Google Cloud Platform. It runs in Cloud Run, a serverless application platform, with Cloud SQL (specifically, Postgres) for data storage. Cloud Build is used to deploy the application. The frontend is built with Bootstrap 5.

The code is hosted here on GitHub. When new code is pushed on main to the gyrinx repo, it is automatically deployed by Cloud Build. This includes running database migrations. Code is tested automatically in Github Actions.

Analytics are through Google Analytics.

Project tasks, issues and to-dos are managed in the Gyrinx GitHub Project.

---

Getting Started

To get started developing Gyrinx:

1. Begin with Key Concepts ⭐ - Overview of the project structure and principles

2. Set up your environment - Follow the setup guide in the GitHub README

3. Dive deeper:

   • Models and Database - Understanding the data layer

   • Frontend Development - Working with templates and styling

   • Testing - Writing and running tests

   • History Tracking - Understanding audit trails

Operations

For deployment and operational information:

• Deployment - How the application is deployed and managed

• Operational Overview - Infrastructure and monitoring

• Runbook - Live operational procedures (team access only)