This commit is contained in:
2024-05-14 11:39:33 +03:00
commit 2762ac794a
26 changed files with 1506 additions and 0 deletions

94
WE.PRO.md Normal file
View File

@@ -0,0 +1,94 @@
## Задачи для Frontend:
1. Создание гридов или контейнеров для ровной вёрстки:
- Эта задача включает в себя создание структуры для размещения элементов пользовательского интерфейса, таких как таблицы, сетки и контейнеры, чтобы обеспечить ровное и качественное отображение на различных устройствах и разрешениях экранов.
2. Реализация возможности смены тем пользователем:
- Здесь требуется добавить функционал, который позволит пользователям выбирать тему оформления приложения, что повысит комфорт использования и персонализацию опыта.
3. Внедрение переключателя для темной и светлой темы:
- Эта задача включает в себя создание интерфейса для переключения между тёмной и светлой цветовой схемой, что позволит пользователям выбирать наиболее подходящий внешний вид приложения.
4. Необходимо добавить редактор markdown файлов:
- Здесь требуется интегрировать редактор, который позволит пользователям создавать и редактировать текстовые файлы в формате Markdown, обеспечивая удобство и эффективность работы с содержимым.
## Задачи для Backend:
1. Разработка системы аутентификации:
- Эта задача заключается в создании механизмов аутентификации пользователей для обеспечения безопасного доступа к приложению.
2. Создание функционала для управления задачами:
- Здесь требуется реализовать функционал для создания, редактирования и управления задачами, что является одним из ключевых функциональных блоков приложения.
3. Реализация личного кабинета пользователя:
- Эта задача включает в себя создание страницы личного кабинета, где пользователи смогут управлять своими данными, настройками и просматривать персональную информацию.
4. Внедрение формы обратной связи:
- Здесь требуется добавить функционал, позволяющий пользователям отправлять обратную связь или сообщения администратору, что повысит взаимодействие и обратную связь с пользователем.
5. Создать генератор yml файлов:
- Все запросы с frontend делаются через openapi, нужно автоматизировать этот процесс.
## Модули на Backend:
1. **Accounts** - Управление пользователями.
2. **Media** - Файловое хранилище.
3. **Main** - Основное приложение.
4. **Articles** - Лента статей и новостей.
5. **Todos** - Ежедневник.
6. **Tenants** - Арендаторы.
7. **Goods** - Имущество.
8. **Properties** - Панель управления недвижимостью.
9. **Teams** - Команда (в процессе доработки).
10. **Documents Flow** - Документооборот (в разработке).
11. **Contracts** - Контракты.
12. **Techdoc** - Техническая документация (в разработке).
13. **Title Documents** - Правоустанавливающие документы (в разработке).
14. **Tech Features** - Технические особенности (в разработке).
15. **Histories** - Журналы обслуживания (в разработке).
16. **Comments** - Комментарии (модели заполняются по мере необходимости).
### В каждом модуле есть :
1. models - Модель таблиц базы данных
2. views - Контроллер запросов
3. serializers - Преобразовывать данные в наборы запросов
4. filters - Фильтр данных
5. urls - Маршрутизатор
## Модули на Backend в разработке:
1. **Teams** - Команда (в процессе доработки).
2. **Documents Flow** - Документооборот (в разработке).
1. Сериализатор
2. контроллер
3. маршрутизатор
4. модель
3. **Techdoc** - Техническая документация (в разработке).
1. Сериализатор
2. контроллер
3. маршрутизатор
4. **Title Documents** - Правоустанавливающие документы (в разработке).
1. Сериализатор
2. контроллер
3. маршрутизатор
4. модель
5. **Tech Features** - Технические особенности (в разработке).
1. Сериализатор
2. контроллер
3. маршрутизатор
4. модель
6. **Histories** - Журналы обслуживания (в разработке).
1. Сериализатор
2. контроллер
3. маршрутизатор
## Контроллер на Backend:
- Необходимо детальнее описать обработку ошибок для различных запросов. Произошёл случай, когда ошибка авторизации была связана с ограничениями прав на редактирование задачи.
- Сейчас режим строгого редактирования данных отключён, но правила ограничений прописаны.
## Описание для Frontend:
- Следует уточнить, является openapi составным ресурсом, определяющим и описывающим API и его элементы.
- Каждый запрос на Backend должен быть подробно описан на Frontend, чтобы избежать ошибок передачи данных.
## Типы данных на Frontend (которые уже можно обрабатывать):
1. **Accounts** - Управление пользователями.
2. **Articles** - Лента статей и новостей.
3. **Todos** - Ежедневник.
4. **Tenants** - Арендаторы.
5. **Teams** - Команда (в процессе доработки).
6. **Comments** - Комментарии.
## Особенности структуры данных:
- Связь между таблицами осуществляется по идентификаторам (id ключам).
- Любые небольшие заполненные данные имеют отдельную таблицу и связываются по идентификаторам.
- Запросы на сервер обрабатываются через fetch и передаются в формате JSON.