Skip to content

Commit ad64785

Browse files
authored
Update Readme
1 parent e74d428 commit ad64785

File tree

1 file changed

+12
-26
lines changed

1 file changed

+12
-26
lines changed

readme.md

Lines changed: 12 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,22 @@
1-
## Описание
1+
# DocSearch
22

3-
Веб приложение для поиска статей в документации InterSystems.
4-
Задача: обеспечить оперативный и эффективный поиск статей в документации InterSystems.
5-
## Технологическое описание
3+
The InterSystems DBMS has a built-in technology for working with non-structured data called iKnow and a full-text search technology called iFind. We decided to take a dive into both and make something useful. As the result, we have DocSearch — a web application for searching in InterSystems documentation using iKnow and iFind.
64

7-
Приложение представляет из себя клиент-серверный комплекс, размещяемый на Windows системе,
8-
и доступный через интерфейс страниц веб сайта по заданному адресу с помощью веб браузера.
9-
На сервере работает приложение:
5+
## Usage description and information about technologies
106

11-
1. На языке Cache Object Script - отвечающее за работу с базой данных,
12-
бизнес логику и обмен основными данными с клиентским приложением;
7+
Read <a href="https://community.intersystems.com/post/search-intersystems-documentation-using-iknow-and-ifind-technologies">post on Developer Community</a>. <a href="https://habrahabr.ru/company/intersystems/blog/333582">Russian article on Habrahabr</a>
138

14-
Также используется клиентское приложение, написанное на языке Javascript и фреймворке Angular.
15-
Приложение работает в браузере и отвечает за работу интерфейса веб страницы и обмен данными с сервером.
9+
## Installation and Usage
1610

11+
Download the Installer.xml file from the latest release available on the corresponding page.
12+
Import the loaded Installer.xml file into the %SYS namespace and compile it.
13+
Enter the following command in the terminal in the %SYS namespace:
1714

18-
## Технологии
15+
do ##class(Docsearch.Installer).setup(.pVars)
1916

20-
Server system - Windows 7/8/10
21-
App client side - Angular.js (Javascript ES5)
22-
App server side - Intersystems Ensemble 2017.1
23-
App database - Intersystems Ensemble 2017.1
17+
The process takes around 15-30 minutes because of the domain builiding process.
2418

25-
26-
27-
### Подготовка окружения
28-
29-
1. Убедиться, что стоит Intersystems Cache, Ensemble или Healthshare версии 2017.1 или позднее и есть лицензия (необходимо для работы iKnow).
30-
2. Загрузить Installer.xml из релиза
31-
3. Импортировать Installer.xml в область %SYS через Студию, скомпилировать. В терминале в области %SYS ввести следующую команду:
32-
do ##class(Docsearch.Installer).setup(.pVars)
33-
Процесс занимает около 30 минут.
34-
Поиск доступен по адресу http://localhost:[порт]/csp/docsearch/index.html
19+
After that, the search will be available at the following address
20+
http://localhost:[port]/csp/docsearch/index.html
3521

3622

0 commit comments

Comments
 (0)