AU-conspectus — различия между версиями

Версия 11:26, 7 ноября 2017

Идея

Хочется реализовать систему, которая позволяет, с одной стороны, вести студентам конспект по алгоритмам в удобном для написания формате markdown документов (писать LaTeX документы на лекции -- это ужасно), а с другой стороны автоматически собирает содержимое написанных лекций в красивый и удобный сайт, с которым повторение прошедших лекций превращается в приятный и увлекательный процесс.

Фичи

Запланировано и сделано:

• Поддержка сквозного содержания всех лекций
• Корректное отображение LaTeX символов на сайте
• Подсветка синтаксиса во вставках кода
• Мобильная версия сайта
• Система баг-репортов (выделил текст, нажал на кнопку -- в репозиторий отправилось issue)
• Telegram-bot, сообщающий о появлении новой лекции в репозитории
• Всплывающие подсказки к терминам, содержащие в себе информацию из википедии

Запланировано и не сделано:

• Подбор ссылок для каждой темы конспекта (neerc, wiki)
• Подбор подсказок на neerc.ifmo.ru/wiki (алгоритм был реализован, однако работал очень криво, и от его использования было решено отказаться)
• Искать ключевые слова, делать поиск, лёгкий NLP

Не запланировано, но сделано:

• Красивые превью ссылки в соцсетях (vk, twitter, facebook, telegram)

Авторы проекта

• Стребежев Игорь: team-лидер; backend: настройка сервиса непрерывной интеграции, реализация telegram-бота; frontend: верстка и логика UI
• Орищенко Александра: backend: генерация AST и .md файлов, генерация .html файлов и извлечение метаинформации из AST; frontend: выделение подсказок у терминов
• Новожилов Дмитрий: backend: поиск и генерация информации для подсказок к терминам, объединение отдельных .html файлов с мета-информацией в целостные, готовые к публикации html страницы, генерация содержания конспекта, генерация сообщений для telegram-бота

В процессе разработки каждый из участников поработал над каждой частью проекта, однако благодаря разработанной архитектуре системы, время каждого участника было распределено так, чтобы не мешать другим.

Известные баги

• Подсказки к терминам не всегда генерируются корректно
• При генерации issue слетает разметка LaTeX формул

Ссылки

Репозиторий: https://github.com/demiurg906/au-conspectus Баг-трекер: https://github.com/xamgore/au-conspectus/issues Конспект: https://xamgore.github.io/au-conspectus/ Видео: https://youtu.be/FAAeSM95ws0 (внимание, включите субтитры)