ytds

Проект представляет собой

Облачный инструмент для поиска документов, который позволяет осуществлять полнотекстовый поиск в документах различных форматов: PDF, Word, Excel, PPT и других. Для индексации документов используется Elasticsearch, а для реализации полнотекстового поиска — API Elasticsearch. LibreOffice используется для преобразования документов в формат PDF с целью обеспечения функции предварительного просмотра онлайн.

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

ytds расшифровывается как: yt (Юту) ds (Документный поиск).

Используемые технологии и фреймворки

В проекте используются следующие технологии и инструменты: Springboot, MySQL, Elasticsearch, Spring, Vue, Element-UI, LibreOffice.

Функционал проекта

1. Авторизация пользователей: пользователи могут зарегистрироваться через свою электронную почту.
2. Полнотекстовый поиск: предоставляет возможность поиска по всему содержимому документа, в отличие от поиска по ключевым словам. Поддерживает различные условия поиска, такие как временные рамки, типы документов и их размеры.
3. Загрузка документов: поддерживает загрузку документов различных форматов, включая Word, PDF, Excel и PPT.
4. Импорт из заметок Impress: позволяет импортировать документы из файлов формата enex, созданных в программе Impress.
5. Управление личными документами: пользователи могут управлять своими документами, включая их статистику, удаление и просмотр.
6. Онлайн-просмотр документов: большинство загруженных документов можно просматривать онлайн, включая те, которые были импортированы из заметок Impress. Просмотр осуществляется путём преобразования документов в PDF с помощью LibreOffice и использования pdf.js.
7. Скачивание оригинальных документов.

Планы на будущее

1. Добавить поддержку редактирования документов с использованием текстовых редакторов.
2. Разработать мобильную версию проекта (ytds-mobile), доступную на мобильных устройствах и в мини-приложениях.
3. Создать настольное приложение (ytds-electron), которое будет отслеживать изменения в файловой системе и автоматически синхронизировать обновлённые документы.

Инструкция по установке

Установка бэкенда ytds

1. Скачайте Elasticsearch с официального сайта.
2. Установите анализатор IK для Elasticsearch, следуя инструкциям на GitHub.
3. Установите LibreOffice, следуя указаниям для вашей операционной системы.
4. Откройте папку с SQL-файлами и импортируйте файл ytds.sql в базу данных MySQL.
5. Измените файл конфигурации application.xml, указав необходимые параметры для работы с Elasticsearch, LibreOffice и другими компонентами.
6. Запустите Elasticsearch и MySQL.
7. Запустите приложение YTDSApplication.

Установка фронтенда ytds

1. Перейдите в проект ytds-fontend и выполните команду npm install для установки зависимостей.
2. Запустите команду npm run dev для запуска сервера разработки.
3. В файле config/index.js измените порт прокси-сервера.
4. Выполните команду npm run build для компиляции кода.
5. В файле application.yml проекта ytds-fontend укажите путь к статическим файлам.

Руководство по использованию

1. После успешного запуска бэкенда запустите фронтенд с помощью команды npm run dev.
2. Откройте браузер и перейдите по адресу localhost:8080.
3. Используйте логин admin и пароль yt520 для входа в систему.
4. Загрузите документы для последующего поиска.

Примеры страниц

1. Страница поиска: позволяет выполнять поиск по документам.
2. Страница загрузки документов: предоставляет возможность загружать документы различных форматов.
3. Страница «Мои документы»: отображает список документов пользователя и позволяет управлять ими.
4. Импорт из заметок Impress: позволяет импортировать файлы формата enex.

Участие в проекте

Для участия в разработке проекта необходимо выполнить следующие шаги:

1. Форк проекта.
2. Создайте ветку dev.
3. Внесите изменения в код.
4. Отправьте запрос на слияние (Pull Request).