FluentCMS

<p align="center"> <a href="https://fluentcms.com" target="_blank"> <picture width="120"> <source srcset="docs/resources/logo-dark.svg" media="(prefers-color-scheme: dark)" /> <source srcset="docs/resources/logo.svg" media="(prefers-color-scheme: light), (prefers-color-scheme: no-preference)" /> <img src="docs/resources/logo.svg" /> </picture> </a> </p> <h3 align="center">FluentCMS: ASP.NET Core Blazor-Based Content Management System (CMS)</h3> <p align="center"> <img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/FluentCMS/fluentcms"> <img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/y/FluentCMS/fluentcms"> <img alt="GitHub License" src="https://img.shields.io/github/license/FluentCMS/fluentcms"> <img alt="GitHub contributors" src="https://img.shields.io/github/contributors/FluentCMS/fluentcms"> <a href="https://discord.gg/WyqYuC6YbY"><img alt="Discord" src="https://img.shields.io/discord/1165300406902067280?label=discord"></a> </p>

Table of contents

• Introduction
• Connect with us
• Features
• Supported Databases
• Getting Started
  • Prerequisites
  • Installation
• Component Library
• Documentation
• Contributing
• License

Introduction

FluentCMS is a modern Content Management System (CMS) built on the powerful ASP.NET Core and the innovative Blazor technology. FluentCMS assists content writers in crafting content more efficiently. Designed to be fast, flexible, and user-friendly, it not only serves as a traditional content-based CMS but also excels as a headless CMS, making it perfect for a diverse range of digital applications.

FluentCMS is an open-source project, and we welcome contributions from the community. If you're interested in helping us improve FluentCMS, please read our CONTRIBUTING.md guide.

Connect with us

<a href="https://discord.gg/WyqYuC6YbY"> <img width="48" height="48" src="/docs/resources/discord.svg" alt="discord"> </a> <a href="https://reddit.com/r/FluentCMS"> <img width="48" height="48" src="/docs/resources/reddit.svg" alt="reddit"> </a> <a href="https://fluentcms.com"> <img width="48" height="48" src="/docs/resources/website.svg" alt="website"> </a>

Features

• Blazing Fast: Built on top of Blazor components for client-side operations.
• Extensible: Easily extend with custom plugins and themes.
• SEO Friendly: Built-in SEO tools to optimize content for search engines.
• Responsive: Mobile-friendly out of the box.
• Modern UI: Sleek and intuitive dashboard for content management.
• Headless Capabilities: API-first design for decoupled applications.
• Multi-Language Support: Easily manage content in multiple languages.
• Role-Based Access Control: Granular control over user permissions.
• Media Management: Upload, organize, and manage media files.
• Content Type Definition: Define custom content types with various fields.
• Content Management: Create, edit, and manage content with ease.
• User Management: Manage users and roles with ease.
• Role Management: Create and manage roles with custom permissions.
• Application Settings: Configure application settings with ease.
• Multiple Site Support: Manage multiple sites from a single dashboard.
• Page Management: Create and manage pages with custom layouts.
• Plugin Management: Extend functionality with custom plugins.

Supported Databases

• LiteDB
• MongoDB
• MySQL (coming soon)
• SQL Server (coming soon)
• SQLite (coming soon)
• PostgreSQL (coming soon)

Getting Started

Prerequisites

• .NET SDK 9.0 or later

Installation

1. Clone the repository:

   git clone https://github.com/fluentcms/FluentCMS.git
   

2. Navigate to the project directory:

   cd FluentCMS/src/FluentCMS/
   

3. Configure the Database

   FluentCMS supports multiple databases. Configure the desired database by following these steps:

   • Set the Database in appsettings.json: Define your database type under Database section. For example, to use LiteDB:

     "Database": "LiteDB"
     

   Available options are: LiteDb, MongoDB, SQLite, SQLServer, MySQL, PostgreSQL

   • Provide Connection Strings in appsettings.json: Set your connection string under "ConnectionStrings" in appsettings.json for the desired database:

     "ConnectionStrings": {
        "DefaultConnection": "Filename=./fluentcms.db"
     }
     

4. Run the application:

   dotnet run
   

5. Visit http://localhost:5000 in your browser.

Component Library

This project includes a custom, independent Blazor-based component library styled with flowbite's Design System. You can learn more in Component Library's README file.

Documentation

For more information on how to use FluentCMS, please refer to our documentation. We are actively working on expanding our documentation to provide more detailed information.

Contributing

We welcome contributions! If you're interested in improving FluentCMS, please read our CONTRIBUTING.md guide.

License

This project is licensed under the MIT License - see the LICENSE file for details.