00mjk / orchard-training-demo-module

Demo Orchard Core CMS and Orchard 1.x module for for you to become an Orchard developer. This module completes the training materials under https://orcharddojo.net.

Lombiq Training Demo for Orchard Core

About

Demo Orchard Core CMS module for training purposes guiding you to become an Orchard developer. Note that this module also has an Orchard 1.x version in the dev-orchard-1 branch of the repository.

If you prefer tutorial videos more then check out the Dojo Course 3, the complete Orchard Core tutorial series.

If you are interested in training materials and personalized Orchard trainings please visit Orchard Dojo.

How to start

The module assumes that you have a good understanding of basic Orchard concepts, and that you can get around the Orchard admin area (the official documentation and the Dojo Course 3 tutorial series may help you with that). You should also be familiar with how to use Visual Studio and write C#, as well as the concepts of ASP.NET Core MVC.

Before you dive deep into this module it'd be best if you make sure that you have done the following:

• You know how ASP.NET Core MVC works. It's important that you understand how ASP.NET Core MVC works or generally what MVC is about. If you are not familiar with the topic take a look at the tutorials at https://docs.microsoft.com/en-us/aspnet/core/tutorials/?view=aspnetcore-3.1.
• You've read through the documentation under https://docs.orchardcore.net/ (at least the "About Orchard Core" section, but it would be great if you'd skim the whole documentation).
• You know Orchard Core from a user's perspective and understand the fundamental concepts underlying the system. (The Dojo Course 3 tutorial series may help you with that.)

The Open-Source Orchard Core Extensions repository showcases a web app using Orchard Core from NuGet packages, and it includes this module too. Furthermore, it also contains all of Lombiq's open-source Orchard themes and modules as a bonus! (Check them out for what we have already solved for you.) So, just use that to work with this module:

1. Clone the repository to the latest dev branch. The repository uses submodules to include all the other projects like this one. Thus when first cloning it you'll need to initialize them: When using a GUI this should happen by default, and when using the command line use the --recurse-submodules switch.
2. Make sure the Lombiq.OSOCE.Web project is the startup project (it should be).
3. Start the app with Ctrl + F5.
4. Set up the website using the "Training Demo" recipe.

Learning Orchard Core with this module

Once the app is running, head over to the StartLearningHere.md file and start exploring all the great things you can do in Orchard Core.

Also if you are brave enough to not follow any guide or you want to start the guide from somewhere else then go to the Map.cs file and jump to any class you are interested in. StartLearningHere.md also has training sections linked so you can go to a broader section.

Be sure to check out the Orchard Dojo Library for Orchard Core for a wealth of Orchard Core guidelines, best practices, development utilities (like scripts and snippets), and more as well!

You can also follow the Dojo Course 3 tutorial series if you like to learn from videos.

Keep in mind that your best living reference of how to do something in Orchard is the official repo and our Open-Source Orchard Core Extensions solution. Clone both and keep the solutions open when you’re working on something so you can quickly look up anything.

If you'd like to clean out comments from code files so you can just see the essence, then use the Comment Remover VS extension to quickly do it.

Take a look at the Recipes menu in the Admin screen to load in additional sample content. This is not included by default to reduce clutter.

Contributing and support

Bug reports, feature requests, comments, questions, code contributions, and love letters are warmly welcome, please do so via GitHub issues and pull requests. Please adhere to our open-source guidelines while doing so.

When adding new tutorials please keep in mind the following:

• Insert tutorial steps into the existing flow, either at the end or between two existing ones. Use "NEXT STATION" comments to indicate the next file the reader should check out.
• If it's a new training section then indicate as such by an "END OF TRAINING SECTION" comment at the end and add it to the list under StartLearningHere.md.
• Add pointers to its classes/files in Map.cs.

This project is developed by Lombiq Technologies. Commercial-grade support is available through Lombiq.