Skip to content

CrestApps/CrestApps.OrchardCore

Repository files navigation

CrestApps - Orchard Core

CrestApps provides a collection of open-source modules designed to enhance Orchard Core, a powerful application framework built on ASP.NET Core.

📖 Documentation

For detailed guides, tutorials, and API references, visit the CrestApps Orchard Core Documentation.

The documentation covers:

Table of Contents

Overview

Orchard Core offers a flexible and scalable foundation for building dynamic, data-driven websites and applications. CrestApps modules are developed to further improve this framework, focusing on:

  • Modularity – Independent modules allow for seamless integration based on project requirements.
  • Security – Designed following industry best practices to ensure application safety.
  • Performance – Optimized for speed and efficiency to maximize Orchard Core's potential.

Project Structure

The CrestApps repository is organized for clarity and ease of use. You can find all modules in the src/Modules folder, with each structured for independent usage and configuration.

  • Modules Folder: Contains all CrestApps modules. Each module includes a README.md file with setup and integration details.

Example Structure:

src/
└── Modules/
    ├── CrestApps.OrchardCore.Users/
    │   ├── README.md
    │   ├── Manifest.cs
    │   ├── ...
    └── OtherModules/
        ├── README.md
        ├── ...

To get started with any module, refer to the documentation site for detailed setup instructions.

Available Modules

You can install individual modules into your web project as needed, or install the CrestApps.OrchardCore.Cms.Core.Targets package to include all modules at once.

Artificial Intelligence Suite

AI Module

Provides services for all AI modules and provide the interface for managing AI profiles and AI Deployments. See the AI Services documentation for more details.

AI Chat Module

Provides interface for interacting with AI chat models like ChatGPT and others. See the AI Chat documentation for more details.

AI Chat Interactions Module

Enables ad-hoc AI chat experiences with configurable parameters, document upload, and RAG (Retrieval Augmented Generation) support. Users can chat with AI models without predefined profiles and upload documents to chat against their own data. See the AI Chat Interactions documentation for more details.

Extension modules:

AI Copilot Orchestrator Module

Provides a GitHub Copilot SDK-based orchestrator as an alternative to the default Progressive Tool Orchestrator. See the Copilot Integration documentation for more details.

AI Data Sources Module

Provides provider-agnostic Data Sources (RAG) management, knowledge base indexing, early RAG, and the DataSourceSearch tool. See the Data Sources documentation.

Provider modules:

Orchard Core AI Agent Module

Enhances the AI Module by providing AI Agents to perform tasks on your Orchard Core site. See the Orchard Core Agent documentation for more details.

Model Context Protocol (MCP) Module

Provides support for the Model Context Protocol (MCP) and contains multiple features:

Azure OpenAI Module

Extends the AI Module by integrating Azure OpenAI services. See the Azure OpenAI documentation.

OpenAI Module

Extends the AI Module by integrating OpenAI-powered services. You can connect to any provider that adheres to OpenAI standard. See the OpenAI documentation for more details.

Azure AI Inference Module

Extends the AI Module by integrating Azure AI Inference services. See the Azure AI Inference documentation.

Ollama Module

Extends the AI Module by integrating any Ollama model. See the Ollama documentation.

Omnichannel Suite

The Omnichannel suite provides a unified communication and activity orchestration layer across channels (SMS, Email, Phone, and more), with a mini-CRM UI and optional AI-driven automation.

Omnichannel (Orchestrator)

The foundation of all communication channels. Provides the core orchestration services and generic webhook entry points. See the Omnichannel documentation.

Omnichannel Management (Mini-CRM)

A mini-CRM that lets you manage contacts, subjects, campaigns, dispositions, activities, and activity batches, and drive next-activity behavior via Orchard Core Workflows. See the Omnichannel Management documentation.

SMS Omnichannel Automation (AI)

Allows AI to automate chatting with customers/contacts using SMS. You define how the AI should handle conversations, and it acts as an agent communicating through your SMS provider. See the SMS documentation.

Omnichannel (Azure Event Grid)

Integrates Azure Event Grid to receive communication events (e.g. from your SMS provider) and route them into Omnichannel. See the Event Grid documentation.

Standard Modules

Users Module

Enhances user management with customizable display names and avatars. See the Users documentation for details.

SignalR Module

The SignalR module enables seamless integration of SignalR within Orchard Core. See the SignalR documentation.

Enhanced Roles Module

Extends the Orchard Core Roles module with additional reusable components. See the Roles documentation for details.

Content Access Control Module

Enables you to restrict content items based on user roles. See the Content Access Control documentation for details.

Resources Module

Provides additional resources to accelerate development. See the Resources documentation.

CrestApps Recipes Module

Provides a structured way to define and retrieve recipe steps. See the Recipes documentation.

Getting Started

Running Locally

Follow these steps to get started with CrestApps:

  1. Clone the Repository:

    git clone https://github.com/CrestApps/CrestApps.OrchardCore.git
  2. Navigate to the Project Directory:

    cd CrestApps.OrchardCore
  3. Build the Solution:
    Ensure you have the required .NET SDK installed, then run:

    dotnet build
  4. Launch the Application:

    dotnet run
  5. Enable Modules:
    Access the Orchard Core Admin Dashboard to enable desired CrestApps modules.

Package Management

This project is actively maintained and evolves alongside Orchard Core.

  • If you're using Orchard Core versions from 2.1 up to 2.3, please use package version 1.2.x.
  • For Orchard Core 3.0.0-preview-18908 and later, please use version 2.0.0-preview-0001 or newer.

Note: In Orchard Core v3 multiple breaking changes were introduced to improve the framework. As a result, we had to divide development into two branches to maintain compatibility.

Production Packages

Stable releases are available on NuGet.org.

Preview Package Feed

Hosted By: Cloudsmith

For the latest updates and preview packages, visit the Cloudsmith CrestApps OrchardCore repository.

Adding the Preview Feed

In Visual Studio

  1. Open NuGet Package Manager Settings (under Tools).
  2. Add a new package source:
    • Name: CrestAppsPreview
    • URL: https://nuget.cloudsmith.io/crestapps/crestapps-orchardcore/v3/index.json

Via NuGet.config

Alternatively, update your NuGet.config file:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <packageSources>
    <clear />
    <add key="NuGet" value="https://api.nuget.org/v3/index.json" />
    <add key="CrestAppsPreview" value="https://nuget.cloudsmith.io/crestapps/crestapps-orchardcore/v3/index.json" />
  </packageSources>
  <disabledPackageSources />
</configuration>

Contributing

We welcome contributions from the community! To contribute:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and commit them with clear messages.
  4. Push your changes to your fork.
  5. Submit a pull request to the main repository.

License

CrestApps is licensed under the MIT License. See the LICENSE file for more details.

About

An open-source module for the Orchard Core framework. CrestApps is a collection of modules designed to extend and enhance the functionality of the Orchard Core framework. Our modules are developed with a focus on usability, security, and performance.

Resources

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors