MDriven Turnkey is the model-driven web application front end for developers who want to run and present an application created with MDriven Designer and MDriven Server.
What MDriven Turnkey does
MDriven Turnkey uses the model and application logic that you define in MDriven Designer to provide browser-based user interfaces. For example, when you model a Customer class and create a ViewModel for maintaining customers, Turnkey can present that ViewModel as an HTML5 application.
A ViewModel defines the data, navigation, actions, and presentation structure for a user interface. Turnkey renders web user interfaces with standard Bootstrap rendering.
Turnkey is part of the MDriven product line. MDriven Server is the back-end server that receives models from MDriven Designer, maintains supported databases, implements client-to-client synchronization, and can execute periodic declarative jobs defined in the model.
Rendering choices
You can choose the rendering approach per screen.
| Choice | Use | Example |
|---|---|---|
| MVC5/Razor | Render a display with MVC5/Razor. | Choose MVC5/Razor for a Customer details display. |
| AngularJS | Render a display as an AngularJS browser application. | Choose AngularJS for a Customer list display that needs rich browser interaction. |
| Blazor | Use Blazor as part of a Turnkey application. | Use Blazor where your application design requires it. |
Turnkey is based on technologies including jQuery, AngularJS, Blazor, MDriven Framework, Azure, SQL Server, MySQL, and PostgreSQL. Its streaming interface can also be used by thin clients that do not use the MVC renderer, AngularJS, or Bootstrap.
Run Turnkey with MDriven Server
In a deployed installation, Turnkey connects to a running MDriven Server through MDrivenServerOverride.xml. The file is in the Turnkey installation's App_Data directory.
For example, on a Linux installation where Turnkey is installed in /var/www/html/mdriventurnkey, edit:
/var/www/html/mdriventurnkey/App_Data/MDrivenServerOverride.xml
Use the installation instructions for your operating system to install and configure both services:
- HowTos:Local Installation describes a Linux installation, including systemd services, ports, firewall access, and logs.
- HowTos:Deploying on MacOs describes installation on macOS Ventura on Intel-based Macs.
On the Linux configuration described in HowTos:Local Installation, MDriven Server uses port 5010 and Turnkey uses port 5011. Open both TCP ports in the firewall when the services must be reached remotely.
Prototype locally
You can run a model locally with Turnkey while you continue to edit it in MDriven Designer. This shortens the edit-save-refresh cycle and lets you inspect the HTML5 application rather than only the WPF-generated prototyper application.
The MDrivenStart Prototyper can start MDrivenTurnkeyCore, a local mini web server. It stores information in a file during prototyping; a production system stores data in a database. When you change the model, the local system updates automatically.
For a local IIS-based Turnkey prototyper, follow Documentation:Faster prototyping with Turnkey. That workflow requires IIS with IIS Management Services and Web Deploy for IIS.
- Import the downloaded MDriven Turnkey package in IIS Manager by choosing Import Application.
- Record the site's URL and its disk path. For example,
http://localhost/MDrivenTurnkey2000andC:\inetpub\wwwroot2\MDrivenTurnkey2000. - In MDriven Designer, save the model as a
.modlrfile. - Select the Play button, choose Local TurnkeyPrototyper, and enter the site URL and disk path.
- Select Start system, then select Run Model and continue modeling.
The local Turnkey prototyper does not require MDriven Server. It uses XML persistence and saves its data next to the model. It can use HTTP; you do not need to configure HTTPS for this local prototyping scenario.
Local assets and refresh
Create a folder named <YourModel>_AssetsTK next to the model to provide local Turnkey assets. Turnkey mirrors this folder into the local site when the model is saved.
For example, create SampleModel_AssetsTK\Content\tkusercss.css, edit the CSS, save the model in MDriven Designer, and refresh the browser. You can use this workflow while developing Angular directives, controls, page overrides, and CSS.
A single local Turnkey site can run different .modlr files from the same directory, one model at a time.
File-permission requirement
If the local Turnkey prototyper does not start, check file permissions.
- MDriven Designer needs access to the Turnkey site files.
- The Turnkey site needs access to the folder containing the
.modlrfile.
For an IIS setup, grant the application-pool account, commonly IIS_IUSRS, access to the model directory. For example, grant the required access to C:\temp\TurnkeyPrototyping when that folder contains your model.
Connect to another Turnkey site
You can configure an MDriven-built system to communicate programmatically and securely with an MDriven Turnkey site. Use this when systems have different models and you need to keep their data synchronized. See Documentation:Remote Turnkey access.