Рефакторинг для веб
- Убраны встроенные заметки - Добавлены разделители - Скрыты шаблоны
This commit is contained in:
parent
2e6b359760
commit
2323059beb
|
@ -1,6 +1,5 @@
|
|||
## название_проекта
|
||||
---
|
||||
>[!название_проекта]
|
||||
>описание_проекта
|
||||
|
||||
**Ccылка:**
|
|
@ -1,6 +1,5 @@
|
|||
## название_ресурcа
|
||||
---
|
||||
>[!название_ресурcа]
|
||||
>описание_ресура
|
||||
|
||||
**Ccылка:**
|
|
@ -1,2 +1,4 @@
|
|||
.obsidian
|
||||
.trash
|
||||
netlify.toml
|
||||
Templates
|
||||
|
|
|
@ -1,5 +1,3 @@
|
|||
# Контроллеры
|
||||
***
|
||||
## Проекты
|
||||
---
|
||||
**URL:** ORUDO.RU/API/PROJECTS/
|
||||
|
@ -18,6 +16,7 @@
|
|||
- *Статусы:* 200 / 403
|
||||
- *Параметры:*
|
||||
- **?API_KEY** - Ключ доступа к API
|
||||
|
||||
## Соц. сети
|
||||
---
|
||||
**URL:** ORUDO.RU/API/SOCIALS/
|
||||
|
|
|
@ -1,9 +1,6 @@
|
|||
# Модели
|
||||
***
|
||||
> Описание структур данных для BackEnd
|
||||
## Виджет (Абстрактный)
|
||||
---
|
||||
>[!Виджет]
|
||||
>Абстрактный класс, описывающий стандартной поведение модели виджета
|
||||
### Поля
|
||||
---
|
||||
|
@ -15,9 +12,9 @@
|
|||
---
|
||||
- **Публичный | В формат БД | Строка** - Преобразовывает модель в формат, необходимый для записи в базу данных
|
||||
- **Публичный | В Json | Строка** - Преобразовывает модель в *.json*
|
||||
|
||||
## Проект
|
||||
---
|
||||
>[!Проект]
|
||||
>Реализация абстрактного класса виджета для описания проектов ORUDO
|
||||
### Поля
|
||||
---
|
||||
|
@ -50,7 +47,6 @@ Projects:
|
|||
|
||||
## Соц. сеть
|
||||
---
|
||||
>[!Соц. сеть]
|
||||
>Реализация абстрактного класса виджета для описания внешних ресурсов ORUDO
|
||||
### Поля
|
||||
---
|
||||
|
|
|
@ -1,9 +1,6 @@
|
|||
# Репозитории
|
||||
***
|
||||
> Модули для доступа к различным элементам базы данных
|
||||
## Репозиторий (Абстрактный)
|
||||
---
|
||||
>[!Репозиторий]
|
||||
>Абстрактный класс, описывающий основные методы для репозитория
|
||||
### Строки
|
||||
---
|
||||
|
@ -13,11 +10,11 @@
|
|||
- **Приватный | Добавить виджет | Целое число | Абстрактный** - Добавляет виджет в базу данных, возвращает id
|
||||
- **Приватный | Получить виджет | Виджет | Абстрактный** - Возвращает данные из базы данных по id
|
||||
- **Публичный | Получить список репозитория | Список целых чисел | Абстрактный** - Возвращает список ключей репозитория
|
||||
|
||||
## Репозиторий проектов
|
||||
---
|
||||
>[!Репозиторий проектов]
|
||||
>Реализации абстрактного класса репозитория для управления проектами
|
||||
|
||||
## Репозиторий соц. сетей
|
||||
---
|
||||
>[!Репозиторий cоц.сетей]
|
||||
>Реализации абстрактного класса репозитория для управления соц. сетями
|
|
@ -1,5 +1,3 @@
|
|||
# Структура
|
||||
***
|
||||
>Описание модулей различных частей проекта, их взаимосвязи и назначения
|
||||
## Общие компоненты
|
||||
---
|
||||
|
@ -11,6 +9,7 @@
|
|||
---
|
||||
**Диаграмма связей компонентов**
|
||||
![[connections.png]]
|
||||
|
||||
## Структура BackEnd
|
||||
---
|
||||
- **[[Утилиты]]** *(Модули для дополнительных ф-ий)*
|
||||
|
@ -27,6 +26,7 @@
|
|||
- [[Модели#Виджет (Абстрактный)|Виджет (Абстракция)]]
|
||||
- [[Модели#Проект|Проект]]
|
||||
- [[Модели#Соц. сеть|Соц. сеть]]
|
||||
|
||||
## Структура FrontEnd
|
||||
---
|
||||
`*требуется составить*`
|
|
@ -1,9 +1,6 @@
|
|||
# Утилиты BackEnd
|
||||
***
|
||||
>Прикладные модули необходимые для различных дополнительных функций
|
||||
## Парсер YAML
|
||||
---
|
||||
>[!YAML Парсер]
|
||||
>Модуль, который сериализует изначальный файл с описанием виджетов в разметке YAML в нативные объекты Python
|
||||
### Поля
|
||||
---
|
||||
|
@ -18,23 +15,19 @@
|
|||
|
||||
## Redis
|
||||
---
|
||||
>[!Redis]
|
||||
>Утилита управления базой данных по протоколу Redis
|
||||
### Поля
|
||||
---
|
||||
- **Хост Redis** - Адрес нахождения базы данных Redis *(Приватный | Аргумент конструктора)*
|
||||
### Методы
|
||||
---
|
||||
- **Публичный | Получить поле | Строка** - Получает поле из БД[^1] по id
|
||||
- **Публичный | Записать поле | Целое число** - Записывает значение поля в БД[^1], возвращает id созданного поля
|
||||
- **Публичный | Удалить поле| None** - Удаляет значение поля из БД[^1]
|
||||
- **Публичный | Очистка | None** - Обнуляет БД[^1]
|
||||
- **Публичный | Получить поле | Строка** - Получает поле из БД по id
|
||||
- **Публичный | Записать поле | Целое число** - Записывает значение поля в БД, возвращает id созданного поля
|
||||
- **Публичный | Удалить поле| None** - Удаляет значение поля из БД
|
||||
- **Публичный | Очистка | None** - Обнуляет БД
|
||||
|
||||
[^1]: База данных
|
||||
## Статические ф-ии
|
||||
---
|
||||
>[!Статические функции]
|
||||
>Функции, которые не относятся к определенному модулю
|
||||
>
|
||||
|
||||
- **Инциализация БД** - Отчищает базу данных, и после заполняет её модулями, полученными из парсера YAML
|
|
@ -1,5 +1,3 @@
|
|||
# Дизайн-система [ORUDO.RU](https://orudo.ru)
|
||||
***
|
||||
## Шрифт
|
||||
---
|
||||
`Описание шрифтов для сайта`
|
||||
|
@ -26,6 +24,7 @@
|
|||
![[Colors_Text.svg]]
|
||||
|
||||
![[Colors.svg]]
|
||||
|
||||
## Компоненты:
|
||||
---
|
||||
### Primary Button
|
||||
|
|
|
@ -1,5 +1,3 @@
|
|||
# Макеты
|
||||
***
|
||||
## Черновой макет
|
||||
---
|
||||
![[MarkupDraft.png]]
|
|
@ -1,9 +1,6 @@
|
|||
# Проекты
|
||||
***
|
||||
> Описание виджетов проектов хостинга ORUDO
|
||||
## CDN
|
||||
---
|
||||
>[!CDN]
|
||||
>описание_сайта
|
||||
|
||||
**Ccылка:**
|
||||
|
@ -11,7 +8,6 @@
|
|||
**Изображение:**
|
||||
## ORUDOCLOUD
|
||||
---
|
||||
>[!ORUDOCLOUD]
|
||||
>описание_сайта
|
||||
|
||||
**Ccылка:**
|
||||
|
@ -19,7 +15,6 @@
|
|||
**Изображение:**
|
||||
## Matrix
|
||||
---
|
||||
>[!Matrix]
|
||||
>описание_сайта
|
||||
|
||||
**Ccылка:**
|
||||
|
@ -27,7 +22,6 @@
|
|||
**Изображение:**
|
||||
## ORUDOWATCH
|
||||
---
|
||||
>[!ORUDOWATCH]
|
||||
>описание_сайта
|
||||
|
||||
**Ccылка:**
|
||||
|
@ -35,7 +29,6 @@
|
|||
**Изображение:**
|
||||
## ORUDO GIT
|
||||
---
|
||||
>[!ORUDO GIT]
|
||||
>описание_сайта
|
||||
|
||||
**Ccылка:**
|
||||
|
|
|
@ -1,9 +1,6 @@
|
|||
# Соц. сети
|
||||
---
|
||||
> Описание виджетов ресурсов ORUDO на других платформах
|
||||
## Discord
|
||||
---
|
||||
>[!Discord]
|
||||
>описание_ресура
|
||||
|
||||
**Ccылка:**
|
||||
|
@ -11,7 +8,6 @@
|
|||
**Платформа:** Discord
|
||||
## Telegram (Live)
|
||||
---
|
||||
>[!Telegram (Live)]
|
||||
>описание_ресура
|
||||
|
||||
**Ccылка:**
|
||||
|
@ -19,7 +15,6 @@
|
|||
**Платформа:** Telegram
|
||||
## "Пиздеж мелкого малдава"
|
||||
---
|
||||
>[!"Пиздеж мелкого малдава"]
|
||||
>описание_ресура
|
||||
|
||||
**Ccылка:**
|
||||
|
@ -27,7 +22,6 @@
|
|||
**Платформа:** Telegram
|
||||
## Matrix Пространство
|
||||
---
|
||||
>[!Matrix Пространство]
|
||||
>описание_ресура
|
||||
|
||||
**Ccылка:**
|
||||
|
|
Loading…
Reference in New Issue