|
1 | 1 | # EventStore.UI
|
2 | 2 |
|
3 |
| -The new user interface for Event Store. This is included as a submodule in the main [Event Store](https://github.com/EventStore/EventStore) repository. |
| 3 | +The user interface for Event Store. This is included as a submodule in the main [Event Store](https://github.com/EventStore/EventStore) repository. |
4 | 4 |
|
5 |
| -## Running new UI |
| 5 | +## Running the UI |
6 | 6 |
|
7 |
| -Currently there are two ways to run the new UI: |
| 7 | +Currently there are two ways to run the UI: |
8 | 8 |
|
9 | 9 | * Open `index.html` located int `src` folder in browser.
|
10 | 10 | * Execute `gulp connect` - this command [gulp-connect](https://github.com/avevlad/gulp-connect) run webserver with LiveReload (see dev section for info how to set up gulp if you are new to it) - `gulp connect` needs `gulp` to run, please see Dev information on how to install it.
|
11 | 11 |
|
12 | 12 | ## Dev
|
13 | 13 |
|
14 |
| -To start developing it's best to install few things |
| 14 | +To start developing, make sure you have the following requirements: |
15 | 15 |
|
16 |
| -#### 1. install [node.js](http://nodejs.org/) if you havent done that already |
17 |
| -#### 2. install [gulp.js](http://gulpjs.com/) |
| 16 | +#### 1. Install [node.js v10.20.1](https://nodejs.org/en/blog/release/v10.20.1/) **and** (Python 2.7)[https://www.python.org/download/releases/2.7/] if you haven't done that already. |
| 17 | + |
| 18 | +If you already have another version of node.js installed, `nvm` can be used to set node v10.20.1 as the active one: |
| 19 | + |
| 20 | +``` |
| 21 | +nvm use 10.20.1 |
| 22 | +``` |
| 23 | + |
| 24 | +nvm for Windows can be downloaded [here](https://github.com/coreybutler/nvm-windows/releases) |
| 25 | +nvm for Linux can be downloaded here [here](https://github.com/nvm-sh/nvm/releases) |
| 26 | + |
| 27 | +After installing Python 2.7, make a copy of the executable `python.exe` found in `C:\Python27` with the name `python2.exe` so that there are 2 executables: `python.exe` and `python2.exe`. This is required otherwise the build script when running `npm install` in the steps below fails when it looks for these executables. |
| 28 | + |
| 29 | +If you don't want to make copies of the python executable, there's a workaround. The commands below will configure `npm` to use the same `python.exe` executable when it looks for `python` and `python2`: |
| 30 | + |
| 31 | +``` |
| 32 | +npm config set python "C:\python27\python.exe" |
| 33 | +npm config set python2 "C:\python27\python.exe" |
| 34 | +``` |
| 35 | + |
| 36 | +Furthermore, make sure the path `C:\Python27\` has been added to the `PATH` variable. In Windows, this can be tested as follows from the **PowerShell**: |
| 37 | +```` |
| 38 | +Get-Command python |
| 39 | +Get-Command python2 |
| 40 | +```` |
| 41 | + |
| 42 | +On Linux, this can be checked as follows: |
| 43 | +```` |
| 44 | +which python |
| 45 | +which python2 |
| 46 | +```` |
| 47 | + |
| 48 | +#### 2. Install [gulp.js](http://gulpjs.com/) |
18 | 49 |
|
19 | 50 | ```
|
20 | 51 | npm install -g gulp
|
21 | 52 | ```
|
22 | 53 |
|
23 |
| -#### 3. install all node packages in project |
| 54 | +#### 3. Install all node packages in the project |
| 55 | + |
| 56 | +``` |
| 57 | +npm install |
| 58 | +``` |
| 59 | + |
| 60 | +If you get MSBUILD, VS2017, or VC++ related errors, follow the steps below to install the missing dependencies: |
| 61 | + |
| 62 | +1. Download Visual Studio Professional 2017 (version 15.9) (Trial) setup from [here](https://my.visualstudio.com/Downloads). |
| 63 | +2. When you run the setup, go to the **Individual components** tab, then use the search box at the top to select these components: |
| 64 | +- Visual Studio C++ core features |
| 65 | +- VC++ 2017 version 15.4 v14.11 toolset |
| 66 | +- Windows 8.1 SDK |
| 67 | +- MSBUILD |
| 68 | +Note that other components might get added automatically; do not remove them. |
| 69 | +3. Click "Install", and then click on "Continue". |
| 70 | +4. Wait for setup to finish installing all the components and dependencies. |
| 71 | +5. Now run these commands in the EventStore.UI directory: |
24 | 72 |
|
25 | 73 | ```
|
| 74 | +npm clean-install |
26 | 75 | npm install
|
27 | 76 | ```
|
28 | 77 |
|
29 |
| -#### 4. install [bower](http://bower.io/) |
| 78 | +#### 4. Install [bower](http://bower.io/) |
30 | 79 |
|
31 | 80 | ```
|
32 | 81 | npm install -g bower
|
33 | 82 | ```
|
34 | 83 |
|
35 |
| -to install bower components |
| 84 | +to install bower components: |
36 | 85 | ```
|
37 | 86 | bower install
|
38 | 87 | ```
|
39 | 88 |
|
40 |
| -#### 5. gulp commands avaliable |
| 89 | +If you get the error message *"bower.ps1 cannot be loaded because running scripts is disabled on this system"*, run the command below in **PowerShell**: |
| 90 | + |
| 91 | +``` |
| 92 | +Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser |
| 93 | +``` |
| 94 | + |
| 95 | +Then, run `bower install` again. |
| 96 | + |
| 97 | +#### 5. gulp commands available |
41 | 98 |
|
42 | 99 | ```
|
43 | 100 | // starts webserver with live reload
|
|
0 commit comments