moved docs from the main lpms repo

.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: ci 
+on:
+  push:
+    branches:
+      - master 
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material 
+      - run: mkdocs gh-deploy --force

.gitignore

@@ -0,0 +1,160 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

.vscode/settings.json

@@ -0,0 +1,13 @@
+{
+    "yaml.schemas": {
+      "https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml"
+    },
+    "yaml.customTags": [ 
+      "!ENV scalar",
+      "!ENV sequence",
+      "!relative scalar",
+      "tag:yaml.org,2002:python/name:material.extensions.emoji.to_svg",
+      "tag:yaml.org,2002:python/name:material.extensions.emoji.twemoji",
+      "tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format"
+    ]
+  }

docs/devlog/log.md

@@ -0,0 +1,73 @@
+# Версии
+
+## 0.4 (ветка [dev](https://github.com/mmmylnikov/lpms/tree/dev))
+
+`2024.04.15`
+
+- Деплой
+    - добавлены файлы для запуска приложения из docker-compose
+    - вынесены в .env из [config/setting](https://github.com/mmmylnikov/lpms/blob/dev/lpms/config/settings.py) настройки базы данных
+- Добавлено приложение [Notify](https://github.com/mmmylnikov/lpms/blob/dev/lpms/notify)
+    - добавлен Телеграм-бот в качестве провайдера уведомлений
+    - уведомления пользователей при включении/выключении уведомлений
+    - студент: уведомления об изменении статуса работы
+- Профиль
+    - управление уведомлениями
+- Таски/Ревью
+    - статус вынесен в отдельную модель, чтобы можно было оценить сколько висит работа в каком-либо статусе
+
+
+## 0.3 (ветка [main](https://github.com/mmmylnikov/lpms/tree/main))
+
+`2024.04.07`
+
+- Настроен CI
+    - настроен [Github Action](https://github.com/mmmylnikov/lpms/blob/main/.github/workflows/django_ci.yml) для Flake8 и Mypy
+- Оптимизированы запросы к бд в темплейтах:
+    - лендинг
+    - профили
+        - студент
+        - куратор
+    - дашборд
+        - студент (уроки и задания недели)
+        - студент (выполнение задачи)
+        - куратор (студенты и ревью)
+- Добавлена утилита [GithubApi](https://github.com/mmmylnikov/lpms/blob/main/lpms/user/utils.py)
+    - возвращает список репозиториев пользователя
+    - возвращает список пулл-реквестов по репозиторию
+- Дашбоард студента
+    - добавлена вьюха [автокомплита](https://github.com/mmmylnikov/lpms/blob/df3f70faaeb48fe082067f66af3576227d6f6795/lpms/dashboard/views.py#L163-L188) репозиториев/пулл-реквестов из github-аккаунта для формы добавления домашней работы 
+    - студент не может редактировать ссылку на пулл-реквест, после отправки на проверку
+- Профиль Студента
+    - доска "канбан" текущих задач по курсу
+- Дашбоард куратора
+    - доски: команды, студенты, ревью
+
+
+## 0.2
+
+`2024.04.01`
+
+- Добавлено приложение [Course](https://github.com/mmmylnikov/lpms/blob/main/lpms/course)
+    - Добавлены модели: Курс, Трек, Набор (Поток), Группа (Команда)
+    - Добавлены точка входа - лендинг со списком и описанием курсов
+- Добавлено приложение [User](https://github.com/mmmylnikov/lpms/blob/main/lpms/user) для работы с учетными записями и ролями 
+    - Переопределены стандартные модели User (Пользователь) и Group (Роли)
+    - Подключена регистрация/авторизация через GitHub OAuth
+    - Добавлена view: просмотр учетной записи
+    - Добавлена view, form: редактирование учетной записи
+- Добавлено приложение [Learn](https://github.com/mmmylnikov/lpms/blob/main/lpms/learn) для организации и управлением обучением
+    - Добавлены модели: Программа, Неделя, Урок, Задание, Домашняя работа
+- Добавлено приложение [Dashboard](https://github.com/mmmylnikov/lpms/blob/main/lpms/dashboard) для вьюх студента и куратора
+    - Добавлен дашборд студента: недели, уроки, задания, контент
+- Добавлены основные [тепмлейты](https://github.com/mmmylnikov/lpms/blob/main/lpms/templates)
+    - Добавлены: Базовый, Хедер, Футер, Лайауты для контента
+    - Переопределены: Логин и Логаут для OAuth
+
+
+## 0.1 
+
+`2024.03.23`
+
+- Проработан проект [ТЗ](https://github.com/mmmylnikov/lpms/blob/main/terms/terms.md)
+- Описан проект [схемы бд](https://github.com/mmmylnikov/lpms/blob/main/terms/db_schema.md)

docs/devlog/todo.md

@@ -0,0 +1,18 @@
+# Задачи
+
+- GithubApi
+    - проверка аппрувов для Ревью Кураторов
+- Приложение Notify
+    - добавить celery для асинхронной отправки сообщений
+    - добавить уведомления куратору для новых тасков от студентов
+- Дашбоард куратора
+    - форма ревью работы студента
+    - доски: успеваемость
+- Деплой
+    - арендовать vds
+    - купить домен
+    - подключить домен к серверу
+- Настроить CD
+    - настроить Github Action для сборки и доставки докер образа на сервер  
+- валидатор для формы добавления пулл-реквеста
+- редизайн админки

docs/index.md

@@ -0,0 +1,19 @@
+# Добро пожаловать!
+
+> Настоящий проект реализуется в рамках подготовки итоговой выпускной работы студента набора LPA5 курса Learn Python Advanced
+
+## Что такое LPMS?
+
+LPMS - Это система управления обучением для курсов от сообщества MOSCOW PYTHON, которая помогает организовать образовательный процесс курсов программирования Learn Python и Learn Python Advanced. 
+
+
+## Возможности LPMS
+
+- Создание и управление курсами
+- Управление доступом к материалам курса
+- Мониторинг успеваемости
+- Интеграция с хостингом проектов (для сдачи домашних заданий)
+- Гибкая система настройки курсов и учебных планов
+- Сбор и анализ статистики обучения
+- Автоматизация процессов управления обучением
+

docs/screenshots/auth.md

@@ -0,0 +1,14 @@
+# Авторизация и профили
+
+> доступно Студенту, Куратору и Анонимному пользователю
+
+| Курсы      | GitHub Oauth  |  Профили  |
+|------------|---------------|-----------|
+|![home](../images/demo/home.gif)| ![oauth](../images/demo/oauth.gif)|![profile](../images/demo/profile.gif)|
+
+
+## Профиль Студента
+
+| Список задач | Канбан задач  |
+|--------------|---------------|
+|![list_tasks](../images/demo/student_list_task.gif)| ![kanban](../images/demo/student_kanban_task.png)|

docs/screenshots/learn.md

@@ -0,0 +1,22 @@
+# Обучение
+
+## Дашборд материалов обучения
+
+> доступно Студенту и Куратору
+
+| Недели      | Контент  |
+|-------------|----------|
+|![weeks](../images/demo/learn_weeks.gif)| ![content](../images/demo/learn_content.gif)|
+
+
+## Дашборд Студента
+
+| Список задач | Выполнение задачи |
+|--------------|-------------------|
+|![dash_list_tasks](../images/demo/student_dashboard_list_task.png)| ![dash_task_execution](../images/demo/student_dashboard_task_execution.gif)|
+
+## Дашборд Куратора
+
+| Список ревью | Список студентов  |
+|--------------|-------------------|
+|![dash_list_review](../images/demo/tutor_dashboard_list_review.gif)| ![dash_list_student](../images/demo/tutor_dashboard_list_student.gif)|