Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/plac3hold3r/mvxscaffolding

🏗️ A customizable template used to scaffold a cross-platform MvvmCross application.
https://github.com/plac3hold3r/mvxscaffolding
dotnet-template mvvmcross templates uwp visual-studio-extension xamarin-android xamarin-forms xamarin-ios
Last synced: about 12 hours ago
JSON representation
🏗️ A customizable template used to scaffold a cross-platform MvvmCross application.
Host: GitHub
URL: https://github.com/plac3hold3r/mvxscaffolding
Owner: Plac3hold3r
License: mit
Created: 2017-11-01T20:49:39.000Z (over 7 years ago)
Default Branch: develop
Last Pushed: 2023-03-02T03:58:00.000Z (almost 2 years ago)
Last Synced: 2025-02-02T03:45:25.572Z (8 days ago)
Topics: dotnet-template, mvvmcross, templates, uwp, visual-studio-extension, xamarin-android, xamarin-forms, xamarin-ios
Language: C#
Homepage:
Size: 6.44 MB
Stars: 122
Watchers: 6
Forks: 40
Open Issues: 64
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project

README

        # MvxScaffolding

[![NuGet](https://badgen.net/nuget/v/MvxScaffolding.Templates)](https://www.nuget.org/packages/MvxScaffolding.Templates/)

[![Visual Studio Marketplace](https://badgen.net/vs-marketplace/v/Plac3Hold3r.MvxScaffolding)](https://marketplace.visualstudio.com/items?itemName=Plac3Hold3r.MvxScaffolding)

[![Build Status](https://plac3hold3r.visualstudio.com/MvxScaffolding/_apis/build/status/MvxScaffolding%20CI)](https://plac3hold3r.visualstudio.com/MvxScaffolding/_build/latest?definitionId=4)

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FPlac3hold3r%2FMvxScaffolding.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2FPlac3hold3r%2FMvxScaffolding?ref=badge_shield)

[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=Plac3hold3r/MvxScaffolding)](https://dependabot.com)

[![Crowdin](https://d322cqt584bo4o.cloudfront.net/mvxscaffolding/localized.svg)](https://crowdin.com/project/mvxscaffolding)

[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)

[![Semver](https://badgen.net/badge/semver/2.0.0/green)](https://semver.org/)

A customizable template used to scaffold a cross-platform MvvmCross application. Includes a .NET Standard class library. Supports Xamarin Android, Xamarin iOS and UWP project types for Xamarin Native and Xamarin Forms. Supports MvvmCross 8.0.2.

![MvxScaffolding screenshot](docs/resources/vs_template_banner.png)

**Templates features**

|                                                     Features                                                      | mvxnative | mvxforms |

| :---------------------------------------------------------------------------------------------------------------: | :-------: | :------: |

|           [.NET Standard class library](https://docs.microsoft.com/en-us/dotnet/standard/net-standard)            |    \*     |    \*    |

| [Package references](https://docs.microsoft.com/en-us/nuget/consume-packages/package-references-in-project-files) |    \*     |    \*    |

|                                                Unit test projects                                                 |    \*     |    \*    |

|                                                 UI test projects                                                  |    \*     |    \*    |

| Solution [EditorConfig](https://docs.microsoft.com/en-us/visualstudio/ide/create-portable-custom-editor-options)  |    \*     |    \*    |

|                                            Android Nougat round icons                                             |    \*     |    \*    |

|                                            Android Oreo adaptive icons                                            |    \*     |    \*    |

|                                         Android support constraint layout                                         |    \*     |

|                                            Android AXML or XML layout                                             |    \*     |

|                                           iOS storyboard launch screen                                            |    \*     |    \*    |

|             iOS storyboard or [FluentLayouts](https://github.com/FluentLayout/Cirrious.FluentLayout)              |    \*     |

See [Changelog](/CHANGELOG.md)

## Installation

|        Platform         |      Installation and System Requirements      |                                             Documentation                                              |                                                  Download                                                   |

| :---------------------: | :--------------------------------------------: | :----------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------: |

|       dotnet CLI        |       [Installation Guide](#dotnet-cli)        |                              [Documentation](docs/template_dotnet_cli.md)                              |                      [NuGet](https://www.nuget.org/packages/MvxScaffolding.Templates/)                      |

| Visual Studio Extension | [Installation Guide](#visual-studio-extension) | [Documentation VS 2017](docs/template_vs_2017.md) or [Documentation VS 2019](docs/template_vs_2019.md) | [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=Plac3Hold3r.MvxScaffolding) |

## Help Translate

If you want to help translate MvxScaffolding into your native language. Please check out our [Crowdin project](https://crowdin.com/project/mvxscaffolding) page.

### Translators

Thank you to the following translators

|      Language         | Code  |                                                                     Translators                                                                      |

| :-------------------: | :---: | :--------------------------------------------------------------------------------------------------------------------------------------------------: |

| Chinese Simplified    | zh-CN | [Forbidden (cptbl00dra1n)](https://crowdin.com/profile/cptbl00dra1n), [Rei Jyo (klakling)](https://crowdin.com/profile/klakling)                     |

| Chinese Traditional   | zh-TW | [Rei Jyo (klakling)](https://crowdin.com/profile/klakling)                                                                                           |

|       Danish          | da-DK | [Tomasz Cielecki (Cheesebaron)](https://crowdin.com/profile/Cheesebaron)                                                                             |

|       French          | fr-FR | [Antoine Bichon (Chapelin)](https://crowdin.com/profile/Chapelin), [An0d](https://crowdin.com/profile/An0d)                                          |

|       German          | de-DE | [Manuel (epsmae)](https://crowdin.com/profile/epsmae)                                                                                                |

|      Italian          | it-IT | [Emanuele Filardo (fileman)](https://crowdin.com/profile/fileman)                                                                                    |

|      Japanese         | ja-JP | [Rei Jyo (klakling)](https://crowdin.com/profile/klakling)                                                                                           |

|       Polish          | pl-PL | [qattiel (Qattiel)](https://crowdin.com/profile/qattiel)                                                                                             |

| Portuguese, Brazilian | pt-BR | [Bazzi](https://crowdin.com/profile/Bazzi), [tobias.16bar](https://crowdin.com/profile/tobias.16bar)                                                 |

|      Russian          | ru-RU | [Alexander Bublik (alex.bublik1093)](https://crowdin.com/profile/alex.bublik1093)                                                                    |

|      Spanish          | es-ES | [Agustin Jose Wawrzyk (elpitufo)](https://crowdin.com/profile/elpitufo)                                                                              |

|    Serbian (Cyrillic) | sr-SP | [dimitrijevic](https://crowdin.com/profile/dimitrijevic)                                                                                             |

|     Turkish  | tr-TR | [Burak‏ Eker (mburakeker)](https://crowdin.com/profile/mburakeker)                                                                                             |

|     Ukrainian         | uk-UA | [Руслан Соромля (garenauser)](https://crowdin.com/profile/garenauser), [Anthony Maisak (anthony.maisak)](https://crowdin.com/profile/anthony.maisak) |

## dotnet CLI

### System Requirements

In order to make use of these templates you will need to have the following installed for Windows or macOS

**Required**

- .NET Core SDK 2.1.4+ ([Download SDK](https://www.microsoft.com/net/download))

**Optional**

- Xamarin Android SDK _(Recommended version 11+)_

- Xamarin iOS SDK _(Recommended version 14+)_

- UWP SDK _(**Windows Only**, recommended version 10.0.19041+)_

### Installation

To install the template run the `-i|--install` command

```text

dotnet new --install MvxScaffolding.Templates

```

### Usage

See [documentation](docs/template_dotnet_cli.md) for how to generate a solution.

## Visual Studio 2017/2019 Extension

### System Requirements

In order to make use of these templates you will need to have the following installed for Windows

**Required**

- Visual Studio 2017 15.8+ (_Recommended Visual Studio 2019 16_ [Download Visual Studio](https://www.visualstudio.com/downloads/))

- .NET Framework 4.7+ ([Download .NET Framework](https://www.microsoft.com/net/download/windows))

**Optional**

- Xamarin Android SDK _(Recommended version 11+)_

- Xamarin iOS SDK _(Recommended version 14+)_

- UWP SDK _(**Windows Only**, recommended version 10.0.19041+)_

### Installation

Download and install the VSIX from [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=Plac3Hold3r.MvxScaffolding) or search in Visual Studio extensions for `MvxScaffolding`.

### Usage

See [documentation VS 2017](docs/template_vs_2017.md) or [documentation VS 2019](docs/template_vs_2019.md) for how to generate a solution.

## Thanks

- To [Windows Template Studio](https://github.com/Microsoft/WindowsTemplateStudio) community

- To [.NET Template Engine](https://github.com/dotnet/templating) community

- To [SideWaffle Template Creator](https://github.com/ligershark/sidewafflev2) community

- To [MvvmCross](https://github.com/MvvmCross/MvvmCross) community

- To [Crowdin](https://crowdin.com) for supporting localization for MvxScaffolding

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FPlac3hold3r%2FMvxScaffolding.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2FPlac3hold3r%2FMvxScaffolding?ref=badge_large)

##### Third party libraries

- [MvvmCross](https://github.com/MvvmCross/MvvmCross) is licensed under [MS-PL](https://github.com/MvvmCross/MvvmCross/blob/master/LICENSE)

- [FluentLayout](https://github.com/FluentLayout/Cirrious.FluentLayout) is licensed under [MS-PL](https://github.com/FluentLayout/Cirrious.FluentLayout/blob/master/LICENSE)

- [Xamarin Android Support Library](https://github.com/xamarin/AndroidSupportComponents/) is licensed under [MIT](https://github.com/xamarin/AndroidSupportComponents/blob/master/LICENSE.md)

MvxScaffolding is licensed under [MIT](https://github.com/Plac3hold3r/MvxScaffolding/blob/master/LICENSE)

## Privacy Policy

The MvxScaffolding Visual Studio extension makes use of 3rd party crash and analytics reporting. See the [privacy policy](docs/privacy_policy.md) for more information.