You can use the MDriven GitHub repository to download sample and mergeable models, inspect reusable Turnkey components, and reuse the included automation examples in your own MDriven projects.
Repository
MDriven maintains its public component repository at supportMDriven/MDrivenComponents. The repository contains material intended for reuse and learning, including:
- Sample models, which show working model patterns.
- Mergeable models, which you can download and select when adding a component to your current model.
- Reusable components, including components for AngularJS and the Blazor client implementation.
- Automation samples, including a command script used as an example for model code generation, build, and upload automation.
Use the repository as a source of examples and reusable building blocks. Review a component and its dependencies before you merge it into a production model.
Download mergeable models in MDriven Designer
Use TK Live View to download the repository's mergeable models to your local machine and make them available for selection in the current model.
- Open your model in MDriven Designer.
- Open TK Live View.
- Select (Re)Download Components from GitHub. This downloads the latest mergeable models to your local machine.
- Go to Components to choose from.
- Select a downloaded component for the current model.
- Review the resulting model changes and adapt the component to the terminology, ViewModels, and behavior of your application.
You must run (Re)Download Components from GitHub before using Components to choose from.
Example
If you need a pattern already represented by a mergeable model, download the components first, then choose that model from Components to choose from rather than recreating the pattern manually. After it is added, inspect the model elements it introduces before changing its behavior or connecting it to existing ViewModels.
Work with repository content
The repository is also useful when you need to inspect implementation material rather than select a mergeable model from MDriven Designer.
- Open supportMDriven/MDrivenComponents in GitHub.
- Locate the sample or component relevant to your task.
- Read the included files to identify the model content, scripts, and client-specific implementation that the sample uses.
- Download or clone the repository using your normal GitHub workflow.
- Apply only the parts that fit your model and deployment architecture.
A component may target a particular client implementation. For example, the repository includes reusable material for AngularJS and the Blazor client implementation. Do not assume that client-specific files can be used unchanged in a different client implementation.
Use the CI automation sample
The repository contains an automation-script example referenced by Continuous Integration. The example is located at:
MDrivenTurnkeyComponents\Samples\Automation\LaunchVSWithModelCodeGenFullBuildAllAndUploadToMDrivenServer.cmd
The script demonstrates an automated sequence that:
- Generates code so it maps to the model.
- Rebuilds the solution before upload.
- Uploads to MDrivenServer to start database evolution and deployment processing.
Use Continuous Integration for the required environment variables, such as the MDrivenServer URL and credentials, and for the complete automation workflow. Do not copy credentials into a checked-in command file.
Related component guidance
Some repository-based integrations require additional client setup. For example, TinyMCE editor describes an AngularJS integration that uses an external AngularJS module, application-wide script inclusion, and a Turnkey asset. Follow the dedicated integration page when a component has its own setup instructions rather than relying only on its repository files.
Before you reuse a component
Check the following before adding downloaded content to a shared model:
| Check | Why it matters |
|---|---|
| Client implementation | Components can be specific to AngularJS or the Blazor client implementation. |
| Model impact | A mergeable model can introduce model elements that must be reviewed alongside your existing classes, associations, and ViewModels. |
| Required assets and scripts | A UI integration can require files such as application-wide script includes, view assets, or Turnkey assets. |
| Deployment automation settings | Automation examples require environment-specific values, including the MDrivenServer endpoint and credentials. |