Skip to content

Code Reference Manual

Welcome to the SAEOSS developer manual. The manual is intended to function as a reference for the application. For narrative / workflow based tutorials.

Below is linked reference manuals for coding languages and frameworks used in SAEOSS-Portal.

You may prefer to work through our developer guide. Here is a brief overview of the content provided here:

  • Coding Conventions: Series of guidelines or rules developers follow when writing code
  • to ensure consistency, readability and maintainability.
  • Project SCrum Board: A visual representation and tracking tool used in Scrum, an agile project management framework.
  • Assets: Here are the static files associated with a CKAN extension or theme.
  • Blueprints: A way to organise a group of related views, templates, and static files
  • Command Line Interface: Text-based interface that allows users to interact with a SAEOSS application by typing commands into a terminal or command prompt.
  • Constants: This contains all the constant variables.
  • Email Notifications: Reimplementation of the core CKAN email notifications.
  • Get Releases: This is a code to get releases from Github
  • Helpers: A utility or module that provides additional functionality, functions, or methods to assist in customising or extending CKAN's features.
  • Jobs: Asynchronous jobs for SAEOSS portal.
  • Logic: Functions responsible for implementing specific business logic, data processing, or functionality within the extension.
  • Migration: Set of files and scripts used to manage changes made to the database schema during updates or version changes.
  • Model: Represents the objects and their relationships that are used to manage and store information.
  • Plugins: Extension or module that adds new features, functionalities, or modifications to the CKAN framework.
  • Public: Here are publicly accessible files, including customised assets, are stored.
  • Scheming: This CKAN extension provides a way to configure and share metadata schemas.
  • Web Server Gateway Interface: WSGI is the Web Server Gateway Interface
  • Test Local Instance: Tests to ensure that various components, functions, and features work as expected.
  • CSW: Here we outline the CSW in SAEOSS.