Welcome to Piranha.Core

Build server	Platform	Build status
GitHub Actions	Windows
GitHub Actions	Linux
CoverAlls
NuGet
Crowdin (Localization)

About

This is a complete rewrite of Piranha CMS. The goal of this rewrite is to create a version capable of targeting multiple platforms & frameworks with minimal dependencies, but still provide a flexible & high performance CMS library.

Piranha is currently built for .NET 6 and uses in its simplest form the following awesome packages:

• AutoMapper
• Markdig
• Microsoft.EntityFrameworkCore
• Newtonsoft.Json

Getting started

Prerequisites

• .NET 6.0 SDK
• An IDE or Editor of your choice

Create a new project from our templates

To use our project templates you first need to download and install them from NuGet. This can be done with:

dotnet new -i Piranha.Templates

When creating a new project with dotnet new you should first create a new empty folder. The default behaviour is that the new project is named after its containing folder.

Please note that naming your project Piranha (even if it is a test project) will result in a circular reference error when you try to restore the packages. This is due to a limitation in dotnet restore.

After this is done you can create a new web project for razor pages with:

dotnet new piranha.razor

To read more about of our available project templates, please read more on https://piranhacms.org/docs/basics/project-templates

Get the latest source code and get going

> git clone https://github.com/PiranhaCMS/piranha.core.git
> cd piranha.core
> dotnet restore
> dotnet build
> cd examples/MvcWeb
> dotnet run

Log into the Manager

The manager interface can be found at the URL ~/manager with the default credentials:

admin / password

For production scenarios we advise you to remove this user, or change the password and update the password strength policy. More information on this can be found in the official documentation here.

Build and update javascript/css assets

> cd piranha.core/core/Piranha.Manager
> npm install
> gulp min:js
> gulp min:css

Visual Studio users

For people running Visual Studio 2017 almost all of the above steps will be handled by the IDE. Just get the source code, open the .sln file and you're good to go.

Backers

Support Piranha CMS with a monthly donation and help us focus on giving you even more features and better support. Piranha CMS @ Open Collective

Sponsors

These are our financial sponsors! You can also become a sponsor either through GitHub or Open Collective.

Code of Conduct

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.

.NET Foundation

This project is supported by the .NET Foundation.