Development

---

This page covers development for the Centurion UI. We welcome contributions and hope that this page, along with our Contribution Guide has fostered you being able to move forward.

We do have Code API documentation. and it can be found in the API documentation section.

Requirements

This section contains the musts for development of this project.

• Use Typescript of Javascript

  Note

  As this project started of using javascript, some files will not be typescript. If there is a major refactor to a javascript file, it's also to be converted to typescript. All new files are to be typescript.

• Document code. At a minimum at least typing and param descriptions.

Tip

We use typedoc for API documentation generation. For the available tags, see the typedoc documentation.

Mock API

We have added as part of our docker container a feature that enables you to mock an API backend. The mock backend only covers read-only actions.

How it works

Centurion UI uses HTTP GET and OPTIONS requests to the backend. This correlates to object data and UI setup respectively. Within the context of the mock API we mimic this via file paths and json files.
Files paths match the URI path one-to-one and the request type either HTTP/GET or HTTP/OPTIONS are a json files named after the request type. i.e. GET.json or OPTIONS.json.

Example

A HTTP/GET Request to URI /mock/api/v2 would have a json file saved within the mock path /mock/api/v2/GET.json If the request was a HTTP/OPTIONS request, the json file saved within the mock path /mock/api/v2/OPTIONS.json

Setup and usage

To use his mock backend, do the following on your development machine:

1. clone the repo locally and enter the repos cloned path.

2. build the docker image.

   docker build . \
       --build-arg "CI_COMMIT_SHA=$(git rev-parse HEAD)" \
       --build-arg "CI_COMMIT_TAG=$(git tag --sort=-creatordate | head -n 1)+$(git rev-parse --short HEAD)" \
       --tag centurion-ui:dev
   

3. Start the docker container

   docker run \
       --rm \
       -d \
       -p 3000:80 \
       -v ${PWD}/includes/etc/nginx/nginx.conf:/etc/nginx/nginx.conf \
       -v ${PWD}/includes/etc/nginx/conf.d/default.conf:/etc/nginx/conf.d/default.conf \
       -v ${PWD}/includes/usr/share/nginx/html/mock:/usr/share/nginx/html/mock \
       --name centurion-ui \
       centurion-ui:dev
   

   Tip

   Within the API_URL var defined, the path after /mock is what you will need to create within the mounted mock path.

   Note

   The mounted mock path (in the above docker run commands case ${PWD}/includes/usr/share/nginx/html/mock) is where you create your api structure.

4. start development ensuring you create the API data within the mack path.

About:

This page forms part of our Project Centurion ERP UI.

Page Metadata

Version: ToDo: place files short git commit here
Date Created: 2026-04-14
Date Edited: 2026-05-17

Contribution:

Would You like to contribute to our Centurion ERP UI project? You can assist in the following ways:

• Edit This Page If there is a mistake or a way you can improve it.
• Add a Page to the Manual if you would like to add an item to our manual
• Raise an Issue if there is something about this page you would like to improve, and git is unfamiliar to you.

 

ToDo: Add the page list of contributors