-
Notifications
You must be signed in to change notification settings - Fork 8
Home
This wiki will some day contain all necessary documentation for maintaining and expending the Squire code. But we are not yet there. Give us time please. We spend a lot of time in writing all the code.
Squire uses Django as the framework. Please check out the Django documentation to understand the fundamentals on how html pages are created from data on the database.
Squire consists of a stack of modules that have been developed over time.
Utils contains functionality that continues on the django project without being specefied to this project. This includes additional testing tools, several view mixins and the root code for ViewCollectives.
Core contains core functionality for Squire. This includes setting up the dynanmic registry, some login logic, error handling, Martor Markdown logic and the root page design of the website.
Contains all Member related logic. It contains the necessary Member model as well as MemberYear and MemberLog (all Member related database changes are logged). It also contains the Middleware that allows request.member to be called in code to retrieve the member. The RequiresMembership mixin can also be found here.
Contains AssociationGroup related logic, including implementing a CommitteeCollective. AssociationGroups are applicable for Committees, Orders, Boards and Roleplaying Campaigns.
Acts as an interface for files stored on the Nextcloud, limiting who can download what files.
Contains all handling for activities and calendar logic within the association. Also links activities to NextcloudFolder instances
Contains logic for an inventory system within the Knights where items can be added and marked by owned by a member or associationgroup (i.e. the association). Uses CommitteeCollective logic to allow AssociationGroups to control their own items.
Extends Inventory logic with a Boardgame catalogue viewable by members.
Extends the Inventory logic with Roleplaying Item catalogue connected to trpg systems viewable by members. Will also contain logic for roleplaying campaigns in the future
An old module that needs a full revision. Allows users (not members) to obtain achievements for feats in the association.
Contains some final front-end logic that encapsulates multiple to all of aforementioned modules. Also initiates AccountCollective for account related settings by the user.