Development

---

This section of the documentation contains different items related to the development of this application. The target audience is anyone whom wishes to develop any part of the application.

Centurion ERP is a Django Application. We have added a lot of little tid bits that aid in the development process. i.e. abstract classes, tests etc. This allows for decreased development times as items that are common are what could easily be considered templated with the only additional requirement is to add that objests differences.

Areas of the code

• Application API Documentation

• Fields

• Forms

• Models

• Templates

• Testing

• Views

Icons

To locate additional icons for use see material icons or more material icons.

Icons with text:

• Success {% include 'icons/success_text.html.j2' with icon_text='success' %} denotes yes, success etc

• Cross {% include 'icons/cross_text.html.j2' with icon_text='cross' %} denotes no, negative etc

• Change {% include 'icons/change_text.html.j2' with icon_text='change' %} denotes that change management needs to run

• Issue {% include 'icons/issue_link.html.j2' with issue=2 %} Used to provide a link to an issue on GitLab. i.e. incomplete feature ticket

Navigation

Within Centurion ERP the navigation menu is dynamically built. To have an item added to the navigation bar to the left of the screen, the following items must be set:

• within the urlpatterns list, the path contains the name parameter.

  Tip

  Don't use a name that starts with _, as this prefix is designed to be used to prevent the url from showing up within the navigation menu

• app_name = "<app name>" set in urls.py

.Example entry

urls.py

from django.urls import path

from access.views import organization


app_name = "Access"


urlpatterns = [
    path("", organization.IndexView.as_view(), name="Organizations"),
]

Tenancy Setup

All items within Centurion ERP are considered tenancy objects. Pay particular attention to any requirement that specifies that a class is to be included. Some of these classes add the required logic for Tenancy object CRUD operations as well as permission checking.

Markdown

To extend the markdown add a plugin to path app/core/lib/markdown_plugins/ ensuring you enable it within app/core/lib/markdown.py with .use(<plugin name>)

About:

This page forms part of our Project Centurion ERP.

Page Metadata

Version: ToDo: place files short git commit here
Date Created: 2024-05-17
Date Edited: 2024-11-13

Contribution:

Would You like to contribute to our Centurion ERP 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