Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/michielpost/DynamicDataCMS
Open source Q42 CMS
https://github.com/michielpost/DynamicDataCMS
asp-net-core blob-storage cms cosmosdb csharp headless-cms jsonschema sia-skynet
Last synced: about 1 month ago
JSON representation
Open source Q42 CMS
- Host: GitHub
- URL: https://github.com/michielpost/DynamicDataCMS
- Owner: michielpost
- License: mit
- Created: 2019-07-11T08:49:15.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-16T06:28:06.000Z (10 months ago)
- Last Synced: 2024-05-01T22:23:37.367Z (9 months ago)
- Topics: asp-net-core, blob-storage, cms, cosmosdb, csharp, headless-cms, jsonschema, sia-skynet
- Language: C#
- Size: 615 KB
- Stars: 8
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/michielpost/DynamicDataCMS/actions/workflows/aspnetcore.yml)
# DynamicDataCMS
Open source Dynamic Data CMS
Developer friendly, headless and modular CMS based on JsonSchema standard
Runs on ASP.Net on .NET 8.0
## Features
- Headless CMS
- Support for multiple datastore plugins (MS SQL, CosmosDB, Azure Storage (Blob / Tables))
- JsonSchema used to describe entities
- View and edit entities
- Create (multiple) page tree's
- Paging and ordering in list view
- Search
- Support for entities in multiple languages
- Upload images and other assets
- Optional user login and admin module
- Optional Azure AD authentication module
- Generate JsonSchema from C# Models
- Easy installation using NuGet packages
## Installation Instructions
Install `DynamicDataCMS.Core` and one of the storage providers from NuGet:
- `DynamicDataCMS.Storage.CosmosDB`
- `DynamicDataCMS.Storage.AzureStorage`
- `DynamicDataCMS.Storage.EntityFramework`
Edit `Startup.cs` and add the following lines to `ConfigureServices`
```cs
services.UseDynamicDataCMS(Configuration)
.UseJsonEditor()
.ConfigureAzureStorage(() => new StorageConfiguration() { ReadCmsItems = true, ReadFiles = true });
```
## Modules
DynamicDataCMS is a modular CMS and different modules are available:
### CosmosDB Data Storage
The CosmosDB module stores CmsItems to Azure CosmosDB. This module does not support storing file data. You can use the Azure Storage module for file data.
```cs
services.UseDynamicDataCMS(Configuration)
.UseJsonEditor()
.ConfigureCosmosDB(() => new StorageConfiguration() { ReadCmsItems = true })
.ConfigureAzureStorage(() => new StorageConfiguration() { ReadFiles = true }); //Optional if you need file storage.
```
Configuration:
```json
"CosmosConfig": {
"Endpoint": "https://localhost:8081",
"Key": "CosmosDB-key"
}
```
### Azure Blob and Table Data Storage
Stores data in Azure Tables and file data to Azure Blob Storage.
```cs
services.UseDynamicDataCMS(Configuration)
.UseJsonEditor()
.ConfigureAzureStorage(() => new StorageConfiguration() { ReadCmsItems = true, ReadFiles = true });
```
Configuration:
```json
"AzureStorageConfig": {
"SharedAccessSignature": "SAS Token generated in Azure Portal", //null to use development storage
"ContainerName": "cms",
"AssetContainerName": "cms",
"StorageLocation" : "Tables" //Tables / Blob / Both
}
```
### MS SQL using Entity Framework
Stores data in MS SQL. Make sure you already have your own working EntityFramework DataContext.
```cs
services.UseDynamicDataCMS(Configuration)
.UseJsonEditor()
.ConfigureEntityFramework()
```
The CMS can now read and write the type `MyModel` from `MyCustomDataContext`. It only knows how to save this model. Make sure to name your cmsType `MyModel` in `CmsConfiguration.json`
### Authentication
Adds user login and user list to the CMS
Add a reference to `DynamicDataCMS.Core.Auth` nuget package.
```cs
services.UseDynamicDataCMS(Configuration)
.UseJsonEditor()
.ConfigureDynamicDataCMSAuthBasic()
```
In the Configure method in Startup.cs add:
```cs
app.UseAuthentication();
app.UseMiddleware();
```
See the example project to add a default first user to the user list.
It's also possible to use Microsft Azure AD:
[Azure AD documentation](src/DynamicDataCMS.Module.Auth.AzureAD)
### Sia Skynet
Stores data on Sia Skynet, a free decentralized CDN and file sharing platform
https://siasky.net
Only files:
```cs
services.UseDynamicDataCMS(Configuration)
.UseJsonEditor()
.ConfigureSiaSkynet(() => new StorageConfiguration { WriteCmsItems = false , ReadFiles = true})
```
It's also possible to store all data on Sia Skynet using SkyDB:
```cs
.ConfigureSiaSkynet(() => new StorageConfiguration() { ReadFiles = true, ReadCmsItems = true, WriteFiles = true, WriteCmsItems = true });
```
Add a secret to your config, the secret is used to generate a private key for SkyDB:
```json
"SkynetConfig": {
"Secret": "cms example secret",
"ExcludedTypes": [ "student", "book" ]
}
```
### IPFS
Stores data on IPFS (InterPlanetary File System), hosted on the distributed web
https://ipfs.io
```cs
services.UseDynamicDataCMS(Configuration)
.ConfigureIpfs();
```
Host can be set in config, uses localhost as default.
### Micrio
[Micrio Module documentation](src/DynamicDataCMS.Module.Micrio)
## Interceptors
Allows you to modify the data before it's saved.
```cs
services.UseDynamicDataCMS(Configuration)
.UseJsonEditor()
.AddInterceptor()
```
Interceptors need to implement the interface `IWriteCmsItemInterceptor`
## Installation Instructions for Development
- Install CosmosDB emulator for Windows https://aka.ms/cosmosdb-emulator
- Install Azure Storage Emulator https://docs.microsoft.com/en-us/azure/storage/common/storage-use-emulator
- Optional (not needed when using emulators): Edit appsettings.json with Cosmos Endpoint and Key
- Run DynamicDataCMS
- Navigate to https://localhost:44341/cms
## Dependencies
JSON Schema Editor
https://github.com/json-editor/json-editor
Azure Cosmos DB
https://github.com/Azure/azure-cosmos-dotnet-v3
NJsonSchema
https://github.com/RicoSuter/NJsonSchema
JavaScript Notifications
https://ned.im/noty/
## Roadmap
- Website SDK / Website usage example
- Searching in list view
- Multiple versions of items (with start and end time)
- Audit Trail (CosmosDB Change Feed / Blob Storage file)
## Ideas
- Configure the CMS from within the CMS
- Build a JsonSchema editor in Blazor?
- Build in JsonSchema Designer, some ideas:
https://bjdash.github.io/JSON-Schema-Builder/
https://jsondraft.com/4c/#tree
https://mozilla-services.github.io/react-jsonschema-form/
https://jsoneditoronline.org/