Welcome to groundwork web¶
groundwork-web provides web app management functions to applications based on the framework groundwork.
It provides the management of the following objects:
- Routes: Define URLs and map functions for rendering froms, templates and more.
- Contexts: Group routes and use common folders and configurations.
- Menus: Define menus and sub-menus for webpages
- Servers: Register own server configurations for easy and fast starts.
- Database Table Views: Register database tables to get generated views for editing database content via web forms.
- Database Table REST Views Get access to database table content via a REST API.
Besides this, the integrated plugins provides functions for:
- starting a ready-to-use flask-debug server
- using a bootstrap-based template with integrated menus
- getting web views of detailed information about registered groundwork objects like plugins, commands, signals, routes and more.
This package contains the following applications, plugins or patterns:
Applications¶
GroundworkWebApp¶
Example application, which mainly loads the plugin GwWeb and GwWebManager
Plugins¶
GwWeb¶
Provides command line commands to show and start web servers. Configures also the web server “flask_debug”.
GwWebManager¶
Provides web views and functions to manage groundwork objects like commands, recipes, signals, web routes and more. Allows the user to get a fast overview about the running applications and its configuration.
Patterns¶
GwWebPattern¶
Allows plugins to register web routes and servers. Cares about the correct setup of flask, on which most groundwork web functions are based on.
GwWebDbAdminPattern¶
Allows the registration of database tables to provide admin web views for them. This enables you to create, read, update and delete (CRUD) content of database tables via a web interface.
GwWebDbRestPattern¶
Allows the registration of database tables to provide a REST interface for them. This enables you to create, read, update and delete (CRUD) content of database tables via a REST interface.