You can use this page to choose a starting path for MDriven, whether you want to learn the model-driven approach, create a Turnkey site, or run a desktop solution from MDriven Framework.

Choose your starting path

MDriven lets you define information in a model and run, execute, or start what you define. The shortest route depends on the result you want to create.

If you want to...	Start here	What you will do
Learn the MDriven concepts and explore the product	Start!	Follow the wiki-based wizard through the main concepts and the relevant supporting topics.
Create and work with a Turnkey site	Documentation:Turnkey	Learn site creation and setup, then continue to Turnkey architecture, how-to guides, features, and deployment material.
Run a desktop solution from a model in Visual Studio	MDriven Framework	Install the framework for Visual Studio 2022, create an MDriven Solution Template project, update its NuGet packages, change the model, generate code, compile, and run.
Start from an MVC project template	Getting started template for MDriven MVC	Obtain the documented template source, enable NuGet package restore, build the solution, configure the persistence mapper, and then change the model and generate code.

Start with the Start! wizard

Start! is the recommended learning route when you are new to MDriven. It is a wiki-based wizard designed to guide you through the main paths in MDriven Designer while pointing out supporting topics when you need them.

MDriven Designer includes advanced options for advanced information-based problems. Do not try to learn every option before you begin. Use Start! to connect an idea to a testable result, then return to the relevant documentation as your model develops.

For example, if your goal is to explore how a model becomes a running application, begin with Start! rather than beginning with deployment or API material.

Set up MDriven Framework in Visual Studio

Use this route when you want to work from the MDriven Solution Template and run the supplied WPF and WinForms applications against the same model.

The documented prerequisite is Visual Studio 2022.

1. Download MDriven Framework from mdriven.net/downloads.
2. Install the VSIX into Visual Studio 2022.
3. In Visual Studio, create a project from the MDriven Solution Template.
4. Refresh the template's NuGet packages to their latest versions. The template projects retrieve MDriven runtime components through NuGet.
5. Open the model, add classes, generate code, compile, and run.

The solution template contains several projects. You are not expected to keep every project; use the template as a known starting point if you need to return to it.

The documented goal for this route is to run WPF for Framework 4.7.2, WinForms for Framework 4.7.2, WPF for .NET 8, and WinForms for .NET 8 against the same model. For package information, continue to MDriven Framework.

Start an MVC template project

Use the MVC template route when you are starting an MDriven MVC project rather than a new Framework solution.

1. Confirm that MDriven Framework is installed in Visual Studio.
2. Follow Getting started template for MDriven MVC to obtain and open the documented source template.
3. Enable NuGet package restore for the solution.
4. Build the solution to verify that it builds.
5. Configure the persistence mapper as described in the template guide.
6. Change the model, generate code, and deploy to your MDriven Server when your application is ready.

Choose Turnkey for site-oriented work

MDriven Turnkey is the documentation entry point for creating and operating Turnkey sites. Begin with its site-creation and initial-setup material, then use the architecture overview when you need to understand the server-side and MVC structure.

For example, after you have created a site, use the Turnkey how-to guides for tasks such as connecting an SPA or accessing a site through FTP. Keep deployment and scaling decisions separate from first-site setup: Turnkey provides dedicated material for Azure deployment, scaling, and load-balancing considerations.

Find specialized documentation when you need it

Use the following pages after you have selected a starting route:

• Showing data for the topic of presenting data.
• API documentation for the MDriven Framework API reference.
• REST API for REST API-related material.
• Documentation:Installation of MDriven Server on Windows 7 Enterprise. for the documented Windows 7 Enterprise MDriven Server installation page.

A practical first-session plan

1. Choose one outcome: learn MDriven concepts, create a Turnkey site, run the MDriven Framework template, or open the MVC template.
2. Follow the corresponding entry page from the table above.
3. Work toward one observable result. For a Framework project, that result can be compiling and running an application after adding a class to the model and generating code.
4. Continue to the focused documentation for your next task instead of configuring deployment, APIs, or alternative hosting environments before your initial project runs.

See also

• Start!
• Documentation:Turnkey
• MDriven Framework
• Getting started template for MDriven MVC
• API documentation

Start with the model

MDriven is a model-driven development platform. Its Developer's Guide describes an approach in which UML-like models are the central description of an application. These models can define business entities, attributes, relationships, constraints, validation rules, and behavior.

The guide states that MDriven can generate databases, user interfaces, and APIs from the model. It also describes using OCL (Object Constraint Language) for validation rules, state machines for object lifecycles, and ViewModels to shape data for particular use cases.

Choose a starting resource

If you want to ...	Start here	What it covers
Get an overview of MDriven and its initial setup resources	Getting Started with MDriven	Introduction material, installation and environment setup, key concepts, and a link to the Onboarding Guide.
Learn about model-driven development	Model-Driven Development Simplified	UML-like modeling, declarative business rules, generated databases and user interfaces, ViewModels, integrations, and deployment options.
Explore MDriven Turnkey	MDriven Turnkey	Site creation and setup, architecture, how-to guides, features and modules, deployment and scaling, and troubleshooting resources.

When you are ready for setup

The Getting Started documentation includes resources for downloading MDriven tools and setting up a local environment. Listed topics include local installation, localhost certificates, Docker Desktop, WSL, IIS, PostgreSQL, Synology deployment, and starting MDriven Designer from the portal.

See also

• Getting Started with MDriven
• MDriven Turnkey
• Model-Driven Development Simplified

Quick start: choose your path

Use the Getting Started resources according to what you need next:

Your goal	Start here
Understand MDriven before setting up an environment	Begin with the Introduction to MDriven, Why Choose MDriven?, How MDriven Works, and Overview of MDriven Products resources listed on this page.
Set up a local MDriven environment	Use Running MDriven Locally with Docker. The documented setup supports Windows, Linux, and macOS, including standard Intel/AMD processors, Apple Silicon, and Alpine Linux. It involves downloading the package for the selected distribution and processor, extracting it, opening a terminal in the extracted folder, and starting the services.
Review concepts while learning	Use the Key Concepts & Glossary resources listed on this page, including Understanding Models in MDriven, Navigating MDriven Interfaces, the Self concept, tuples, WhenAndWhereProject, and data transformation.

For the documented Docker setup, the local MDriven Server address is http://localhost:5011, subject to the port configured in compose.yaml, and the Turnkey App address is http://localhost:5012.

See also

• Running MDriven Locally with Docker
• Get Started with WSL (Windows Subsystem for Linux)

Recommended learning path

If you are new to MDriven, use the following sequence to move from orientation to hands-on work:

1. Start with the introduction and key-concept material in this Getting Started section. These resources cover what MDriven is, why to use it, how it works, its products, models, interfaces, the Self concept, tuples, and general concepts and practices.
2. Set up your environment using the installation and environment resources that apply to your development setup. Available topics include downloading MDriven Tools, local installation, localhost certificates, Docker Desktop, WSL, IIS Express, IIS installation, PostgreSQL, and related deployment options.
3. Choose a first hands-on path:
   1. For MDriven Framework work, continue with the Framework documentation's installation and setup material, then the first-project or .NET-project guidance.
   2. For practical configuration, integration, deployment, styling, debugging, testing, or automation tasks, use the HowTos section.
   3. For guided modeling practice, begin Bootcamp Chapter 1. It starts with installation guidance, creating and saving an empty model, creating a Person class, adding a string attribute named Name, and using XML persistence.
4. Continue to the Onboarding Guide for a structured learning path, as recommended by this Getting Started section.

See also

• MDriven Framework Documentation
• HowTos Section Overview
• Bootcamp Chapter 1

Start here if you are new to MDriven

Use the following path to move from initial setup into modeling and the next stage of learning.

1. Begin with the Installation & Environment Setup resources on this page. Start with Download MDriven Tools and then select the installation or environment guide that matches your setup.
2. Continue with the MDriven Designer documentation and begin with Modeling Basics. The Designer documentation also includes resources on associations, ViewModels, actions, data persistence, testing, and integration.
3. If you want to create a Turnkey site, continue with the MDriven Turnkey documentation. Its getting-started resources include Introduction to MDriven Turnkey, Creating Your First Turnkey Site, and Setting Up a New Turnkey Site.
4. Use HowTos for task-focused guidance on configuration, development and integration, installation and deployment, debugging, and testing. The HowTos section also points readers to the First MDriven Framework Project and the Getting Started Template for MDriven MVC.
5. Return to this page's Key Concepts & Glossary and Next Steps sections as you deepen your understanding. The next-steps section links to the Onboarding Guide for a structured learning path.

Choose your next path

If you want to...	Continue with...
Learn modeling, ViewModels, actions, persistence, or testing	MDriven Designer documentation
Create a Turnkey site or learn Turnkey architecture and deployment	MDriven Turnkey documentation
Find task-focused setup, development, deployment, troubleshooting, or testing guidance	HowTos

See also

• MDriven Designer
• MDriven Turnkey
• HowTos

Next Steps

Now that you have a foundational understanding of MDriven, explore more detailed documentation and tutorials to deepen your knowledge and skills.

If you need to send user invitations, see Onboarding. It describes sending an invitation link that uses an external-ID reference. When the target page is password protected, the user is redirected to login or registration; after registration, the referenced object can be linked to CurrentUser.

Happy developing with MDriven!

Page currency

Last updated:

Use this date to determine when the Getting Started guidance was last reviewed, especially before following installation and environment setup links.