Devdays Осень 2017/shared online buffer — различия между версиями

Материал из SEWiki
Перейти к: навигация, поиск
(Обновил ссылку на видео)
 
(не показано 10 промежуточных версий этого же участника)
Строка 1: Строка 1:
 +
= Информация о проекте и планах =
 +
 
Состав команды:
 
Состав команды:
 
* Голышев Роман
 
* Голышев Роман
Строка 6: Строка 8:
 
Features:  
 
Features:  
 
* Любой человек может создать новую сессию буффера  
 
* Любой человек может создать новую сессию буффера  
−
* При создании буффера появляется на него создается read-only ссылка, которую можно публично шарить
+
* При создании буффера на него создается read-only ссылка, которую можно публично шарить
−
* При изменени текста в буффере изменения автоматически отображаются у тех, у кого открыта read-only
+
* При изменени текста в буффере изменения автоматически отображаются у тех, у кого открыта read-only ссылка
 +
* На сервере хранится последняя версия текста в буффере
  
−
Репозиторий: [https://github.com/fedochet/shared-online-buffer]
+
Возможные улучшения:
 +
* Установка времени жизни буффера
 +
* Пароль на read-only ссылки
 +
* Подсветка синтаксиса
 +
 
 +
Очевидные проблемы:
 +
* параллельное редактирвание
 +
** решение - забиваем
 +
* разные версии браузеров
 +
** решение - забиваем (последний Chrome)
 +
 
 +
Предполагаемый стек:
 +
* backend: python + Django
 +
* обновление буфферов у читателей через web-сокеты
 +
 
 +
Proof-of-Concept plan:
 +
* один буффер по фиксированному адресу с фиксированной read-only ссылкой
 +
 
 +
 +
 
 +
= Результаты =
 +
 
 +
Здесь перечислены результаты трехдневной работы, а также ссылки на материалы для ознакомления с ней.
 +
 
 +
== Вклад участников ==
 +
 
 +
* Голышев Роман
 +
** разработка схемы взаимодействия компонент
 +
** интеграционные задачи
 +
** документация и презентация проекта
 +
** имплементация части логики по рассылке обновлений
 +
 
 +
* Кузнецов Александр
 +
** настройка работы с веб-сокетами в django
 +
** реализация логики читателей со стороны фронтенда
 +
** создание новых документов
 +
** логика выдачи документов по url
 +
** подсветка синтаксиса
 +
 
 +
* Шеметова Екатерина
 +
** создание каркаса веб-приложения для django
 +
** настройка схемы БД и написание CRUD-а
 +
** настройка работы с веб-сокетами в js
 +
** написание логики писателей со стороны фронтенда
 +
** создание и верстка лэндинга
 +
** генерация токенов для документов
 +
** обработка ошибок
 +
 
 +
== Выполненные задачи ==
 +
 
 +
Запланировано и сделано:
 +
 
 +
* все цели из списка запланированных Features
 +
** создание буфера
 +
** редактирование
 +
** read/write-ссылки
 +
 
 +
Сделано из опционального:
 +
 +
* подсветка синтаксиса (без сохранения в БД)
 +
* ограничение на множественное редактирование
 +
* отображение недавно созданных буферов
 +
 
 +
Не сделано:
 +
 
 +
* редактирование названия буфера
 +
* удаление буфера
 +
* защита паролем
 +
* время жизни буфера
 +
 
 +
== Ссылки ==
 +
 
 +
Репозиторий с кодом и инструкцией по установке: [https://github.com/fedochet/shared-online-buffer]
 +
 
 +
Последний релиз: [https://github.com/fedochet/shared-online-buffer/releases/tag/1.0]
  
 
Список известных багов: [https://github.com/fedochet/shared-online-buffer/issues]
 
Список известных багов: [https://github.com/fedochet/shared-online-buffer/issues]
 +
 +
Презентация (work in progress): [https://docs.google.com/presentation/d/1GVQlbBJYIiT3MripEP6fxZNAk-CRlbduJCvxjNH9Umw/edit#slide=id.g2843a7bd1e_0_1052]
 +
 +
Видео-демонстрация: [https://www.youtube.com/watch?v=rwgYSa8rVEw]

Текущая версия на 12:29, 7 ноября 2017

Информация о проекте и планах

Состав команды:

  • Голышев Роман
  • Кузнецов Александр
  • Шеметова Екатерина

Features:

  • Любой человек может создать новую сессию буффера
  • При создании буффера на него создается read-only ссылка, которую можно публично шарить
  • При изменени текста в буффере изменения автоматически отображаются у тех, у кого открыта read-only ссылка
  • На сервере хранится последняя версия текста в буффере

Возможные улучшения:

  • Установка времени жизни буффера
  • Пароль на read-only ссылки
  • Подсветка синтаксиса

Очевидные проблемы:

  • параллельное редактирвание
    • решение - забиваем
  • разные версии браузеров
    • решение - забиваем (последний Chrome)

Предполагаемый стек:

  • backend: python + Django
  • обновление буфферов у читателей через web-сокеты

Proof-of-Concept plan:

  • один буффер по фиксированному адресу с фиксированной read-only ссылкой


Результаты

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

Вклад участников

  • Голышев Роман
    • разработка схемы взаимодействия компонент
    • интеграционные задачи
    • документация и презентация проекта
    • имплементация части логики по рассылке обновлений
  • Кузнецов Александр
    • настройка работы с веб-сокетами в django
    • реализация логики читателей со стороны фронтенда
    • создание новых документов
    • логика выдачи документов по url
    • подсветка синтаксиса
  • Шеметова Екатерина
    • создание каркаса веб-приложения для django
    • настройка схемы БД и написание CRUD-а
    • настройка работы с веб-сокетами в js
    • написание логики писателей со стороны фронтенда
    • создание и верстка лэндинга
    • генерация токенов для документов
    • обработка ошибок

Выполненные задачи

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

  • все цели из списка запланированных Features
    • создание буфера
    • редактирование
    • read/write-ссылки

Сделано из опционального:

  • подсветка синтаксиса (без сохранения в БД)
  • ограничение на множественное редактирование
  • отображение недавно созданных буферов

Не сделано:

  • редактирование названия буфера
  • удаление буфера
  • защита паролем
  • время жизни буфера

Ссылки

Репозиторий с кодом и инструкцией по установке: [1]

Последний релиз: [2]

Список известных багов: [3]

Презентация (work in progress): [4]

Видео-демонстрация: [5]

Источник — «http://mit.spbau.ru/sewiki/index.php?title=Devdays_Осень_2017/shared_online_buffer&oldid=13638»