@@ -67,28 +67,34 @@ URL example: `http://.../index.html?domain=1&queryType=similar&seed=plane`
6767Development
6868-----------
6969
70- Requires [ Node.JS] ( https://nodejs.org ) (v4.0.0-7.5.0+) (but may work on previous versions),
71- [ Git] ( https://git-scm.com ) and
72- [ Caché] ( http://www.intersystems.com/library/software-downloads/ ) 2016.2+
73- to be installed.
70+ Development requires [ Node.JS] ( https://nodejs.org ) (v4.0.0-7.5.0+) (but may work on previous
71+ versions as well), [ Git] ( https://git-scm.com ) and
72+ [ Caché] ( http://www.intersystems.com/library/software-downloads/ ) 2016.2+ to be installed.
7473
75- To install & test, open up a terminal and execute the following set of commands:
74+ Development of the project lies completely outside of Caché (in any environment you like). The
75+ project tree has three main entry points:
76+
77+ 1 . [ Static client files] ( src/static ) at ` src/static ` . This is the front-end part of the application
78+ which will be packed by Gulp and put to ` StaticData.cls ` class.
79+ 2 . [ Server package] ( src/cls ) at ` src/cls ` . It contains all Caché classes in UDL format. The
80+ directory structure inside ` src/cls ` directory corresponds to the package structure in Caché.
81+ 3 . [ Import scripts] ( import.cmd ) that make the development like a charm: set up once and use one
82+ command to import/export project to/from Caché.
83+
84+ There are some steps needed for initial setup:
7685
7786``` sh
7887git clone https://github.com/intersystems-ru/iknow-entity-browser
7988cd iknow-entity-browser
8089npm install
81- npm run gulp
8290```
8391
84- Then, open ` build/static/index.html ` file.
85-
86- To install application directly to Caché, modify the constants in the ` import.bat ` file and then run
87- it with the following command:
92+ Then, edit ` Pre-configured variables ` section in ` import.* ` script to match your system. Now you're
93+ ready! Run the following:
8894
8995``` bash
90- import
96+ import # or ./import on *nix systems
9197```
9298
93- This will build the project and put all ` src/cls/* ` classes into your Caché. Also, this will
94- export XML file that can be imported to any Caché system (2016.2+).
99+ This will build the project and put all classes into your Caché. Also, this will export XML file
100+ that can be imported to any Caché system (2016.2+).
0 commit comments