Skip to content

Latest commit

 

History

History
165 lines (126 loc) · 9.62 KB

File metadata and controls

165 lines (126 loc) · 9.62 KB

SharpSite

Built With .NET All Contributors

.NET Build + Test Test Results End-to-End Test Results

A modern, accessible CMS built with .NET 9 and Blazor that combines the simplicity of traditional content management with the power of modern web development.

Purpose

SharpSite aims to be a highly customizable content management system that adapts to your website needs. Whether you're a non-technical user looking to create a simple blog, or a developer wanting to build a complex web application, SharpSite provides the flexibility to customize as little or as much as you need using HTML, Markdown, C#, or Blazor code.

System Requirements

  • .NET 9 SDK
  • PostgreSQL 16 or later
  • Visual Studio 2022 or VS Code (recommended)
  • Docker or Podman container runtime

Getting Started

  1. Clone the repository

  2. Configure your PostgreSQL connection string in appsettings.json

  3. Ensure your container runtime (Docker or Podman) is running

  4. Run the application using your preferred method:

    • Using Visual Studio: Open SharpSite.sln and run the AppHost project
    • Using command line: dotnet run --project src/AppHost
  5. Navigate to https://localhost:5001 in your browser

Default Administrator Account

  • Username: admin@localhost
  • Password: Admin123!

Current Features

Core Features

  • Authentication & Authorization

    • Built-in user management with roles (Admin, Editor, User)
    • Social login support with external authentication providers
    • Two-factor authentication (2FA) with authenticator apps
    • Email confirmation and account recovery
  • Content Management

    • Blog posts and custom pages creation
    • Markdown and HTML content support
    • RSS feed generation
    • Automatic sitemap generation
    • Robots.txt customization
  • System Features

    • Flexible theming system
    • Plugin architecture for extensibility
    • Localization support for admin interfaces
    • User-friendly admin dashboard
    • PostgreSQL database support

Administration

  • Complete user management interface
  • Plugin configuration and management
  • Site settings customization
  • Content moderation tools

Planned Features

Our roadmap includes exciting features to enhance the platform's capabilities:

Core Enhancements

  • Content versioning and history
  • Advanced output caching
  • Docker container support
  • Email notification system
  • Full-text search capabilities
  • Form builder with customizable CRUD operations

Content Management

  • Content tagging and categorization
  • Content scheduling and publishing
  • Social media integration
  • Content export and backup tools
  • Static site generation
  • Multi-tenant support

Advanced Features

  • Multiple database support (beyond PostgreSQL)
  • Email mailing list management
  • Payment processing integration
  • WordPress import wizard
  • Mobile app for content management

Developer Features

  • Enhanced plugin development tools
  • API documentation and examples
  • Custom theme development kit
  • Performance optimization tools

User Personas

SharpSite is designed to serve three key user types:

Content Creator

  • Non-technical users who want to create websites without coding
  • Focus on content creation through user-friendly interfaces
  • Uses built-in templates and visual editors

Web Developer

  • Familiar with HTML, CSS, and basic web technologies
  • Can customize themes and layouts
  • Creates custom templates and styling

System Integrator

  • Experienced with Blazor, .NET, and web development
  • Develops custom plugins and extensions
  • Implements complex integrations and features

Contributing

We welcome contributions from all skill levels! See CONTRIBUTING.md for guidelines.

Contributors

Jeffrey T. Fritz
Jeffrey T. Fritz

💻 📆
Mario 'DeepX' Staats
Mario 'DeepX' Staats

🎨 🌍
MdeBruin
MdeBruin

💻
DjeeBay
DjeeBay

🌍 💻
Dimitar Pramatarov
Dimitar Pramatarov

🌍
Emmanuel Genga
Emmanuel Genga

🌍
Joan Magnet
Joan Magnet

🌍
default-writer
default-writer

📖 💻
Tero Kilpeläinen
Tero Kilpeläinen

💻
Declan McIlhatton
Declan McIlhatton

🎨 💻
Occular Malice
Occular Malice

💻
JustCallMeAD
JustCallMeAD

💻
Lucy Llewellyn
Lucy Llewellyn

💻