add README

2017-12-09 20:24:11 +03:00
parent 23041cef7b
commit 5d6e363ab4
1 changed files with 38 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,38 @@
+# KinoSearch 3
+
+Сервис просмотра сериалов и фильмов с "варезных" онлайн-кинотеатров без рекламы.
+
+## Системные требования
+
+Java: 1.8  
+База данных: MongoDB 2 и выше
+
+## Модули
+
+### Spider
+
+Данный модуль является "ботом", который ходит по "варезным" онлайн-кинотеатрам
+и парсит от туда информацию о фильмах/сериалах, которую потом загружает в локальную базу данных.
+
+Таким образом, поиск нужного фильма/сериала происходит в разы быстрее.
+
+### Webapp
+
+Собственно сам сайт, через который пользователи смотрят свои любимые фильмы и сериалы.
+
+## Настройка
+
+В папке, где находится сама программа, есть файл настрек `application.properties`.
+Нас интересуют следующие параметры:
+
+`mongo.host` - хост/IP базы данных 
+
+`mongo.port` - порт базы данных
+
+`mongo.db` - наизвание базы данных
+
+`saveRootDir` - папка, где будут храниться все постеры к фильмам и сериалам
+
+`webapp.host` - хост/IP на котором будет работать модуль **Webapp**
+
+`webapp.port` - порт для работы модуля **Webapp**