Giter Club home page Giter Club logo

prism-boilerplate's Introduction

What is prism-boilerplate

Prism-Boilerplate is a basic setup for WPF application with Prism library installed, which is targeting .NET Core.

Technical Prerequisite

  1. Visual Studio 2019
  2. .NET 5.0

Personal Prerequisite

You need to be familiar with

  1. C#.
  2. WPF
  3. Prism library

When should I used it

if you are creating new WPF application targeting .NET Core and you will setup Prism library, then this project will save your time by providing some of the basics that you need for almost every WPF prism project.

Is prism-boilerplate an architecture?

Well, No. It is just a basic setup to save you from the chores of setting up an WPF Prism application.
You can architect your project as you want, which give you the flexibility you need.
Prism-boilerplate will give you intitial boost for the start of the project.
and Also will give you some important building blocks to use them along the way.

How to use it

for now you can clone the repository and change the name of the projects as you want.
for future releases we will improve this process to make it easier.

What is the architecture of the template

  1. WPF application (Startup Project) which represnet very thin layer to access the project.
  2. Modules folder, which contains two projects.
    - SharedModule: which basically contains all the basic setup for the project.
    - MainModule: which is basically an example module, it is just for demonstration. it contains No important functionality.

What is the benifits

  1. FileDialogService which is MVVM way to call OpenFileDialog.

  2. MessageBoxService which is MVVM way to call WPF MessageBox methods.

  3. Base View-Model already containing all the services in the project
    The base View-Model will provide the access to :

    • IEventAggregator: service to allow you send and subscribe for prism events. (Prism Service)
    • IRegionManager: service to allow you manage the regions for the applications modules. (Prism service)
    • IDialogService: service to allow you open new windows in MVVM way (Prism service)
    • IFileDialogService: service to allow you access the OpenFileDialog.
    • IMessageBoxService: service to allow you access the MessageBox.
    • ILogService: service to allow you log errors and info.
  4. One class in the shared module to manage all your Region Names.

  5. One class in the shared module to manage all your Events.

  6. LogService for logging service.
    NLog is installed and confguired.

Contributions

Pull Requests is very welcomed
There is no need to change your style to contribute on this repository
Code with your own standards
It is our mission to re-style your code if your PR merged.

prism-boilerplate's People

Contributors

hakamfostok avatar ha-nso-li avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.