it-beard/bloggers-cms

Content-management system for bloggers

Bloggers CMS - это система управления контентом, разрабатываемая специально под задачи блогеров.
Работает на базе технологий .NET 7 и Blazor WebAssembly

CMS позволяет вести учёт:

• Контента
• Участников контента
• Клиентов
• Доходов и расходов
• Подарков и конкурсов

Дополнительные фичи:

• Система аутентификации на базе Auth0 (может быть отключена)
• Гибкая система внутренних настроек
• Гибкие фильтры по сущностям
• Возможность вести учёт нескольких Брендов в рамках одного интерфейса
  • "Бренд" - это сущность, к которой привязывается контент, участники контента, доходы и расходы. Это может быть отдельный YT-канал, блогер, проект, компания и т.д.
• Небольшие рекомендательные возможности

Запуск

1. Установите и настройте SQL базу данных
2. Отключите Auth0-аутентификацию
   • По умолчанию в CMS включена Auth0-аутентификация, требующая дополнительных танцев с бубном.
   • Для отключения Auth0-аутентификации выставьте параметр Auth0:Enabled в значение false в следующих файлах:
     • bloggers-cms/Pds/Pds.Web/wwwroot/appsettings.Production.json - отключает аутентификацию на стороне фронтенда
     • bloggers-cms/Pds/Pds.Web/wwwroot/appsettings.LocalDevelopment.json - отключает аутентификацию на стороне локального инстанса фронтенда (localhost)
     • bloggers-cms/Pds/Pds.Api/appsettings.json - отключает аутентификацию на стороне бекенда
3. Настройте CMS в соответствии с описанием в разделе "Основные настройки".
4. Запустите проекты Pds.Api и Pds.Web

Миграция базы данных произайдёт автоматически при первом запуске проекта Pds.Api

Docker support

Для запуска приложения в тестовом режиме достаточно ввести команду docker compose -f "./Pds/.run/docker-compose.yaml" up -d

Особенности работы приложения в Docker:

1. По умолчанию Auth0-аутентификация выключена.
2. Данные из базы хранятся в выделенном volume, что позволяет сохранить состояние даже после перезагрузки/пересоздания контейнеров.
3. Нет поддержки TLS/SSL, следовательно все работает по HTTP.
4. Приложение запущено в режиме Development
5. Фронтенд доступен по ссылке http://localhost:5000.
6. Для хостинга Blazor используется NGINX

Основные настройки

Проект Pds.Web

Это фронтенд Blogger CMS, работает на Blazor WebAssembly

Основные настройки расположенны в файлах bloggers-cms/Pds/Pds.Web/wwwroot/appsettings.Production.json (используются на продакшене) и bloggers-cms/Pds/Pds.Web/wwwroot/appsettings.LocalDevelopment.json (используются при запуске локально)

• Секция Auth0 содержит настройки аутентификации Auth0.
• Параметр BackendApi:Url содержит URL развернутого инстанса Pds.Api.

Проект Pds.Api

Это бекенд-api Blogger CMS, работает на .NET

Настройки проекта находятся в файле bloggers-cms/Pds/Pds.Api/appsettings.json

• Секция Logging содержит настройки логирования. Значения по-умолчанию изменений не требуют.
• Секция AllowedOrigins содержит список корневых URL'ов разрешенных фронтенд-приложений. Внесите сюда корневую ссылку на развернутый инстанс Pds.Web.
• Секция Auth0 содержит настройки аутентификации Auth0.
• Параметр ConnectionStrings:DefaultConnection содержит строку подключения к базе данных.

Полезные ссылки

• Настройка аутентификации в CMS через Auth0: https://github.com/it-beard/bloggers-cms/wiki/Authorisation-configuration
• Wiki проекта: https://github.com/it-beard/bloggers-cms/wiki
• Kanban-доска: https://github.com/orgs/it-beard/projects/4

Общение

По всем вопросам сюда

Лицензия

Apache License 2.0, подробнее тут LICENSE.

bloggers-cms's Issues

Несколько персон к одному контенту

"Delete person" button

Should be implemented in Persons list page
Only archived person can be deleted
Before delete should appears popup with confirmation.

Filters for "Persons list" page

Карта персон

Необходимо создать карту, на которой будут отображаться все персоны из системы

Create person page

Related to #4

Initialize DI

• Add Autofac support
• Create slim "Person" page and show persons from DB

Авторизация слетает при открытии приложения в новой вкладке

Похожую багу чел описывает тут: dotnet/aspnetcore#20574

Looks like hidden iframe does not work in our app, should be fixed.

Step to reproduce:

1. Open app and login
2. Open any link in the new tab

Result: in the new tab, you do not authenticated
Expected result: in the new tab you auntehtiacated

Implement user checking while authentication

As an owner of the system, I must be able to grant or dismiss access to the system for users by their email.
As a possible solution, I suggest create a table "Users" and save their emails of users that have assess to the system.
While authentication through Auth0 (#3 ) we also need check if the user exists in DB and only after that grand access

Can we use middleware for that? IDK if it possible for Blazor. Will see.

Setup EntityFramework

• Add EF into DAL
• Setup migrations
• Add initial models & tables (Persons, Adresses, Links)
• • See https://github.com/itbeard/people-discovery-system/wiki/Entities for a better understanding of DB structure

Bug with Dates while save content or pay

Date from the UI sent with local ofsett and saved incorrectly. Offset should be removed

Проверка существования клиента при создании

При создании клиента необходимо на стороне бэкенда проверять есть ли клиент с таким же именем (обе стороны проверки привести к lowercase). Если есть - выдавать на UI соответствующую ошибку

Возможность добавлять несколько топиков к персоне

Пример реализации можно подсмотреть на странице "Создание Персоны" на примере добавления ссылок.
Либо ещё как-то, учитывая, что топиков будет много (лукаб-боксы??)

В дефолтной миграции нет брендов

Описание бага: без брендов проект не заведется

Ожидаемое поведение: нужно добавить два дефолтных бренда - АйТиБороду и Тёмный Лес

Страница "Редактирование Контента"

Поиск, фильтрация и пагинация страницы "Персоны"

Page with Persons should be extended by additional logic:

• Pagination
  • 10
  • 30
  • 50
  • 100
• Searching by
  • Full Name
  • Location
  • Info
  • Resources name and links
• Ordering by
  • Full Name
  • Rating
  • Location

Удаление клиентов возможно только при отсутсвии счетов от них

Если у клиента нет привязанных Bill, то удалять можно.
Апи + UI

Добавить "бесплатный" контент

На UI создания контента добавить чекбокс "бесплатно". В этом случае для контента не создается Bill и в списке контента от отображается как "Бесплатно"

Develop Persons controller API contracts

Develop getting person details logic for PersonService

Service will return details about a person by his id.

I am not sure about this information:

• Locations?
• Resources?

Develop creating person logic for PersonService

Validation process:

• check required fields
• check if the person already exists

Results:
Information about a person saves in the database
Creating a request with wrong information about the person returns an error result with a description.

"Person card" page

Кнопка "Добавить ссылку" на странице добавления персоны

Описание бага: неверная надпись кнопки "Добавить ссылку"

Ожидаемое поведение: поменять на "Добавить ещё"

Шаги воспроизведения:
Зайти на страницу добавления персоны https://pds-web-dev.azurewebsites.net/persons/add

Неверный редиректо после логина в системе

Описание бага: При логине в системе пользователя всегда перенаправляет на главную страницу

Ожидаемое поведение: Перенаправление должно быть на страницу, с которой производился логин

Удаление персоны возможно только при отсутствии контента с ней

Заимплементить указанное поведение.
Сейчас можно удалять любую персону.
Не забыть про UI - выводить число контента с персоной (на странице всех персон) и от его кол-ва показывать или скрывать кнопку удаления

Test auth token may be workable on Prod API

Check is it a try. If yes - another auth0 tenent should be created for Prod

Страница "Темы" (Topics)

As a User I want to be able add Topics and then assign Peoples to particular topics
Examples:

• Rust
• Type Script
• AI

Should to be implemented:

• DB entity
• Page for List of topics

Страница редактирования Персоны

Роут вида: persons/{id}/edit

Персоны создаются без привязки к бренду

Описание бага: На данный момент можно создать персону без привязки к бренду

Ожидаемое поведение: Персона должна быть обязательно привязана к бренду

Шаги воспроизведения: На странице создания персоны не выберайте бренд и создайте её

Страница создания Персоны

Related to #4

Заменить надпись лейбы "ипэ"

Описание бага: сейчас в лейме paymentType при переводе на сокращенный русский пишется "ипэ".

Ожидаемое поведение: сменить "ипэ" на "ип"

Шаги воспроизведения:
Страница "Список Контента"

"Unarchive" button

Archived persons can be unarchived. After the unarchived status of the person changed to "active" and "UnarchivedAt" field seted by UTC datetime now

Related issues: #13 #4

Страница "Просмотр Контента"

Страница "Просмотр Персоны"

Необходимо создать страницу, на которой будет отображаться информация о персоне.
Роут вида: persons/{id}

Номер и дата договора

Добавить для Bill поля "ContractNumber" & "ContractDate"
При оплате контента наUI отображать инпуты для этих полей, если выбран тип оплаты "ИП"

Initiate project

Create an init structure of the project:

• Create initial projects
• • initiate Namespaces
• • set .net core version
• • prepare three-layer architect (services, dal, blazor UI proj)
• • add a project for service tests
• Push it to develop and master

Aut0 authentication

User should be able to see content only after authentication through https://auth0.com
Use Google as an account provider for authentication

Test env: wrong redirect after logout

Actual behaviour:

• You are redirected to https://localhost:5001/
  Expected behaviour:
• You should be redirected to https://pds-web-dev.azurewebsites.net/

Страница "Создание Топика"

As a User I want to be able add Topics and then assign Peoples to particular topics
Examples:

• Rust
• Type Script
• AI

Fields

• Id
• Name
• CreatedAt
• UpdatedAt

"Archive" button

As the user of the system, I should be able to archive a person.

• Archived person does not shown on "Person list" by default
• • Should be able new filter "status" with values: "active","archived", "all"
• Archived person does not shown on the map

Добавление персоны через телеграм-бота

Можно обсуждать и бить на части

Сменить название сущности "Channel" на "Brand"

Описание бага: по факту, система оперирует не каналами, а целым брендом. Базовые сущности на данный момент привязаны к Каналам, но это нелогично, например, когда мы привязываем контент из телеграми или инсты или ведение мероприятия к каналу. Это активности уже не канального масштаба, а масштаба целого бренда.

Ожидаемое поведение: Необходимо заменить название на "Brand" в БД и везде по коду, включая ChannelId -> BrandId

Dashboard: общая информация

На главной странице необходимо красиво выводить статистическую информацию:

• Кол-во персон (втч. не архивных)
• Кол-во контента (по типам соцсетей)
• Кол-во клиентов

Страница "Редактирование Клиента"

Сортировка на странице "Клиенты"

Описание бага: неверная сортировка на странице клиентов

Ожидаемое поведение: вортировка в алфовитном порядке

Add Repositories and UnitOfWork to DB project

Create person page

Related to #4

Страница "Просмотр Клиента"

Страница "Редактирование Клиента"

Страница "Редактирование Персоны"

person/{id}/edit

Add Auth0 google authentication

User should be able to see content only after authentication through https://auth0.com