Skip to content

Latest commit

 

History

History
148 lines (95 loc) · 11.5 KB

README.md

File metadata and controls

148 lines (95 loc) · 11.5 KB

Windows Template Studio

Windows Template Studio (WinTS) is a Visual Studio 2019 Extension that accelerates the creation of new Universal Windows Platform (UWP) and Windows Presentation Foundation (WPF .NET Core 3.1) apps using a wizard-based experience. The resulting project is well-formed, readable code that incorporates great development features while implementing proven patterns and best practices. Sprinkled throughout the generated code we have links Docs, Stack Overflow and blogs to provide useful insights. WinTS supports creating UWP apps in C# or VB.Net and WPF (.NET Core 3.1) apps in C#.

Windows Template Studio UWP screenshot

Windows Template Studio WPF screenshot

Build Status

Branch CI Test Version Version
release Build status Prerelease Version Production Version
dev Build status Nightly Version
Branch Full Tests OneByOne Tests WACK Tests
release Full Integration Tests OneByOne Integration Tests Wack Tests
dev Full Integration Tests OneByOne Integration Tests Wack Tests

The builds include test verifications to validate the contributions:

  • CI Build: Includes all unit test + minimum integration verifications (minimum generation + build + code style rules). Runs every PR requested / PR accepted.
  • Full Tests: Includes tests to verify combinations and variations of templates from a project generation point of view and builds the solutions generated to ensure no build time issues found. Runs every PR accepted and takes longer to be completed.
  • One By One Tests: Includes tests to verify every template individually from a project generation point of view and builds the solutions generated to ensure no build time issues found. Runs once every week and takes longer to be completed.
  • Wack Tests: Includes tests that run the App Certification Kit against the generated projects to ensure there are no issues blocking a submission to the store. Runs once nightly and takes quite a while to complete.

Features

Windows Template Studio approaches UWP and WPF app creation using the following six attribute sets:

Project type

First, how do you want your app's UI navigation to behave?

App design pattern

Next, what coding pattern do you want to use in your project.

App pages

To accelerate app creation, we provide a number of app page templates you can use to add common UI pages into your new app. We currently include everything from a blank page, to common layouts (e.g., master/detail, web view), to pages that implement common patterns (e.g., app settings). Use the wizard to add as many of each page as you need, providing a name for each one, and we'll generate them for you.

Features

Specify which capabilities you want to use in your app, and we'll build out the framework for the features into your app, tagging TODO items. Here you can add features that enable your app to interact with storage, notifications, layout theming, etc.

Services

Connect to data services, setup cloud connected services for your application, and enforce rules with the XAML Styler extension.

Automated Tests

Lastly, you can include test projects for your application to run unit tests or use Selenium-like UI test automation.

After selecting the items wanted in your app, you can extend the generated code on UWP or WPF.

Documentation

Known issues

  • You can't have side-by-side versions (nightly/pre-release/release) of Windows Template Studio VSPackage into a single instance of Visual Studio.

Feedback, Requests and Roadmap

Please use GitHub issues for feedback, questions or comments.

If you have specific feature requests or would like to vote on what others are recommending, please go to the GitHub issues section as well. We would love to see what you are thinking.

Here is what we're currently thinking in our roadmap.

Contributing

Do you want to contribute? We would love to have you help out. Here are our contribution guidelines.

Principles

  1. Generated templates will be kept simple.
  2. Generated templates are a starting point, not a completed application.
  3. Generated templates must be able to compile and run once generated.
  4. Generated templates should work on all device families.
  5. Templates should have comments to aid developers. This includes links to signup pages for keys, MSDN, blogs and how-to's. All guidance provide should be validated from either the framework/SDK/library’s creator.
  6. All UWP features will be supported for two most recent RTM Windows 10 Updates. Those supported releases are Windows 10 May 2020 Update (version 2004) and Windows 10 May 2019 Update (version 1903).
  7. Templates released in production will try to adhere to the design language used in the current release of Windows 10.
  8. Code should follow .NET Core coding style.

This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. For more information see the .NET Foundation Code of Conduct.

License

This code is distributed under the terms and conditions of the MIT license.

Privacy Statement

The extension logs basic telemetry regarding what is selected in the wizard. Our Telemetry Data page has the trends from the telemetry. Please read the Microsoft privacy statement for more information.

.NET Foundation

This project is supported by the .NET Foundation.

Projects we like and collaborate with

Frameworks and libraries in generated code not created by our team

Frameworks

Libraries