←Back
HMX/Website & Framework/Overview

🌐 Website & Framework

Web framework, dashboards, widget library, and website rendering layer.

What's in this scope

The Website & Framework scope groups 6 HMX modules that together deliver end-to-end functionality for this area. Each module below focuses on a specific capability — click any card to jump to its documentation.

This scope comprises 6 Django apps under hmx/module/basic/, defining 1 models, 5 API endpoints, and 15 views collectively. Modules share dependencies and can be installed independently. External dependencies: base, core_school, hmx_api, mail.

CW

Core_Website

Core_Website Description

W

Webx

Module webx

WD

Webx Dashboard

Module webx_dashboard

WS

Webx School

Module webx_school

WW

Webx Widget

Module webx_widget

TW

Test Website

Module test_website

Scope Statistics

📦

6

Modules in scope

🗃️

1

Data models

🔌

5

API endpoints

🖥️

15

UI views

📂

0

Menu items

⚡

3

Actions

Module Relationships

core_website
↔
webx
↔
webx_dashboard
↔
webx_school
↔
webx_widget
↔
test_website

Modules within the Website & Framework scope — often used together and share data models.

HMX/Website & Framework/Getting Started

Getting Started

Install, configure, and enable the Website & Framework scope in your HMX instance.

Prerequisites

  • Module base must be installed
  • Module core_school must be installed
  • Module hmx_api must be installed
  • Module mail must be installed

Installation Steps

Step 1: Install core_website

Core_Website Description

hmx update install core_website --alias=default --noinput

Step 2: Install webx

Install the Webx module via hmx CLI.

hmx update install webx --alias=default --noinput

Step 3: Install webx_dashboard

Install the Webx Dashboard module via hmx CLI.

hmx update install webx_dashboard --alias=default --noinput

Step 4: Install webx_school

Install the Webx School module via hmx CLI.

hmx update install webx_school --alias=default --noinput

Step 5: Install webx_widget

Install the Webx Widget module via hmx CLI.

hmx update install webx_widget --alias=default --noinput

Step 6: Install test_website

Install the Test Website module via hmx CLI.

hmx update install test_website --alias=default --noinput

Post-install Checks

💡After installing, verify each module appears in hmx list-modules and check that their menus are reachable from the HMX UI navigation.
HMX/Website & Framework/Core_Website

Core_Website

Core_Website Description

Overview

Core_Website Description

💡Technical identifier: core_website. See the Technical mode toggle at the top for full data model and API reference.

Module Information

📦

Name

Core_Website

🏷️

Version

1.0.0

📂

Category

Core_Website Category

🔗

Depends

0 modules

Dependencies

none

Security & Access

ACL rules: 1    Groups: 0

HMX/Website & Framework/Webx

Webx

HMX module: webx

Overview

HMX module: webx

💡Technical identifier: webx. See the Technical mode toggle at the top for full data model and API reference.

Module Information

📦

Name

Webx

🏷️

Version

1.0

📂

Category

Hidden

🔗

Depends

3 modules

Dependencies

basehmx_apimail

Data Models 1

ModelClassTypeFieldsSource
basefilterBaseFilterextends basefilter0base_filters.py

Security & Access

ACL rules: 4    Groups: 0

HMX/Website & Framework/Webx Dashboard

Webx Dashboard

HMX module: webx_dashboard

Overview

HMX module: webx_dashboard

💡Technical identifier: webx_dashboard. See the Technical mode toggle at the top for full data model and API reference.

Module Information

📦

Name

Webx Dashboard

🏷️

Version

1.0

📂

Category

Hidden

🔗

Depends

2 modules

Dependencies

basewebx

API Endpoints 5

MethodPath
POST/get_all_dashboard_menus
POST/get_dashboard_content
POST/get_dashboard_by_action
POST/get_dashboard_by_menu_action
POST/get_chart_data

Security & Access

ACL rules: 3    Groups: 0

HMX/Website & Framework/Webx School

Webx School

HMX module: webx_school

Overview

HMX module: webx_school

💡Technical identifier: webx_school. See the Technical mode toggle at the top for full data model and API reference.

Module Information

📦

Name

Webx School

🏷️

Version

1.0

📂

Category

Apps

🔗

Depends

2 modules

Dependencies

core_schoolwebx

Security & Access

ACL rules: 1    Groups: 0

HMX/Website & Framework/Webx Widget

Webx Widget

HMX module: webx_widget

Overview

HMX module: webx_widget

💡Technical identifier: webx_widget. See the Technical mode toggle at the top for full data model and API reference.

Module Information

📦

Name

Webx Widget

🏷️

Version

1.0

📂

Category

Hidden

🔗

Depends

2 modules

Dependencies

basewebx

Security & Access

ACL rules: 1    Groups: 0

HMX/Website & Framework/Test Website

Test Website

HMX module: test_website

Overview

HMX module: test_website

💡Technical identifier: test_website. See the Technical mode toggle at the top for full data model and API reference.

Module Information

📦

Name

Test Website

🏷️

Version

1.0

📂

Category

Hidden

🔗

Depends

2 modules

Dependencies

basewebx
HMX/Website & Framework/Technical Reference

Technical Reference

Complete registry of data models and API endpoints across all modules in this scope.

All Data Models 1

ModuleModelClassFields
webxbasefilterBaseFilter0

All API Endpoints 5

ModuleMethodPath
webx_dashboardPOST/get_all_dashboard_menus
webx_dashboardPOST/get_dashboard_content
webx_dashboardPOST/get_dashboard_by_action
webx_dashboardPOST/get_dashboard_by_menu_action
webx_dashboardPOST/get_chart_data