UI Migration

[jon-nfc]

This issue is to track the work required for the UI to migrate to it's own project.

Details

At this stage the proposal is that the ui move to it's own repository and be developed using react.js.

Models

• defines detail layout

Serializers

Serializes to be separated into three types:

• Base
• Model
• View

Base Serializer

provides the basic details to show as a JSON dict. contains id, name and url.

Model Serializer

user for the creation and update of an item and contains ALL fields defined in display order, including any additional fields as specified within the View Serializer. these additional fields must be set as read_only=True

View Serializer

Used to serializer to display the data. related fields are redefined to use their own base serializer.

defines parameter _urls: dict that always contains key _self which is the items detail view url.

Requirements

• API redesign #248

• UI Proof of concept #319

• url patterns defined

  • /module/model

  • /module/model/pk

  • /module/model/pk/child_model

  • /module/model/pk/child_model/pk

  • /module/model/common_name

  • /module/model/common_name/pk

  • /module/model/common_name/pk/child_model

  • /module/model/common_name/pk/child_model/pk

• Root API URL HTTP/OPTIONS method contains navigation key

• Each detail view of model specifies the page layout key for HTTP/OPTIONS method

• normalised URLs

• follows nav structure

API Requirements

• notate within model docs that if field is mandatory, don't add attribute default to the field. This prevents swagger from showing it a required.

Features to migrate

• Markdown Rendering
  • https://www.npmjs.com/package/markdown-it

Existing work that may affect UI

• UI dates to return in browser timezone centurion_erp_ui#4
• model index view #23
• CSS cleanup centurion_erp_ui#2
• Search capability for model tabs/index pages centurion_erp_ui#3
• Filters for model index page(s) centurion_erp_ui#5
• User customizable items per page centurion_erp_ui#6
• Additional status icons on Devices page centurion_erp_ui#8
• custom permissions selection field(s) centurion_erp_ui#7
• refactor views to auto-generate permission_required #143
• Markdown Context Variables #150
• Device icons #225
• Calendar integration #253
• API Refactor tickets to have views per ticket type #264
• add style for admonitions #272
• ticket labels/tags #278
• Add assigned tasks in side menu #297
• API fields for devices #317

Links

• Related: chore: initial work centurion_erp_ui#1

/cc @jasonpagetas, fyi and for your input