AU-conspectus — различия между версиями
Материал из SEWiki
Alexandra (обсуждение | вклад) |
Xamgore (обсуждение | вклад) (→Авторы проекта) |
||
| (не показано 10 промежуточных версий 3 участников) | |||
| Строка 1: | Строка 1: | ||
| − | + | == Идея == | |
| − | + | Хочется реализовать систему, которая позволяет, с одной стороны, вести студентам конспект по алгоритмам в удобном для написания формате markdown документов (писать LaTeX документы на лекции — это ужасно), а с другой стороны автоматически собирает содержимое написанных лекций в красивый и удобный сайт, с которым повторение прошедших лекций превращается в приятный и увлекательный процесс. | |
| − | + | [https://xamgore.github.io/au-conspectus/ Посмотреть конспект] | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | === Фичи === | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | Запланировано и сделано: | |
| + | * Поддержка сквозного содержания всех лекций | ||
| + | * Корректное отображение LaTeX символов на сайте | ||
| + | * Подсветка синтаксиса во вставках кода | ||
| + | * Мобильная версия сайта | ||
| + | * Система баг-репортов (выделил текст, нажал на кнопку -- в репозиторий отправилось issue) | ||
| + | * Telegram-bot, сообщающий о появлении новой лекции в репозитории | ||
| + | * Всплывающие подсказки к терминам, содержащие в себе информацию из википедии | ||
| − | + | Запланировано и не сделано: | |
| + | * Подбор ссылок для каждой темы конспекта (neerc, wiki) | ||
| + | * Подбор подсказок на neerc.ifmo.ru/wiki (алгоритм был реализован, однако работал очень криво, и от его использования было решено отказаться) | ||
| + | * Искать ключевые слова, делать поиск, лёгкий NLP | ||
| − | + | Не запланировано, но сделано: | |
| − | + | * Красивые превью ссылки в соцсетях (vk, twitter, facebook, telegram) | |
| − | + | ||
| + | == Авторы проекта == | ||
| + | |||
| + | * Стребежев Игорь: team-лидер; настройка сервиса непрерывной интеграции, реализация telegram-бота; верстка и логика UI | ||
| + | * Орищенко Александра: генерация AST и .md файлов, генерация .html файлов и извлечение метаинформации из AST; выделение подсказок у терминов | ||
| + | * Новожилов Дмитрий: поиск и генерация информации для подсказок к терминам, объединение отдельных .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 (внимание, включите субтитры) | ||
| − | + | Презентация: https://goo.gl/CvcUcQ | |
Текущая версия на 16:03, 7 ноября 2017
Содержание
Идея
Хочется реализовать систему, которая позволяет, с одной стороны, вести студентам конспект по алгоритмам в удобном для написания формате markdown документов (писать LaTeX документы на лекции — это ужасно), а с другой стороны автоматически собирает содержимое написанных лекций в красивый и удобный сайт, с которым повторение прошедших лекций превращается в приятный и увлекательный процесс.
Фичи
Запланировано и сделано:
- Поддержка сквозного содержания всех лекций
- Корректное отображение LaTeX символов на сайте
- Подсветка синтаксиса во вставках кода
- Мобильная версия сайта
- Система баг-репортов (выделил текст, нажал на кнопку -- в репозиторий отправилось issue)
- Telegram-bot, сообщающий о появлении новой лекции в репозитории
- Всплывающие подсказки к терминам, содержащие в себе информацию из википедии
Запланировано и не сделано:
- Подбор ссылок для каждой темы конспекта (neerc, wiki)
- Подбор подсказок на neerc.ifmo.ru/wiki (алгоритм был реализован, однако работал очень криво, и от его использования было решено отказаться)
- Искать ключевые слова, делать поиск, лёгкий NLP
Не запланировано, но сделано:
- Красивые превью ссылки в соцсетях (vk, twitter, facebook, telegram)
Авторы проекта
- Стребежев Игорь: team-лидер; настройка сервиса непрерывной интеграции, реализация telegram-бота; верстка и логика UI
- Орищенко Александра: генерация AST и .md файлов, генерация .html файлов и извлечение метаинформации из AST; выделение подсказок у терминов
- Новожилов Дмитрий: поиск и генерация информации для подсказок к терминам, объединение отдельных .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 (внимание, включите субтитры)
Презентация: https://goo.gl/CvcUcQ
