Skip to content

Commit 103f1a1

Browse files
committed
Update README.md with proper dev setup instructions
This commit adds the proper instructions to build EventStore.UI and also details the steps for fixing common errors when building the project.
1 parent 68f969a commit 103f1a1

File tree

1 file changed

+67
-10
lines changed

1 file changed

+67
-10
lines changed

README.md

Lines changed: 67 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,100 @@
11
# EventStore.UI
22

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.
44

5-
## Running new UI
5+
## Running the UI
66

7-
Currently there are two ways to run the new UI:
7+
Currently there are two ways to run the UI:
88

99
* Open `index.html` located int `src` folder in browser.
1010
* 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.
1111

1212
## Dev
1313

14-
To start developing it's best to install few things
14+
To start developing, make sure you have the following requirements:
1515

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/)
1849

1950
```
2051
npm install -g gulp
2152
```
2253

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:
2472

2573
```
74+
npm clean-install
2675
npm install
2776
```
2877

29-
#### 4. install [bower](http://bower.io/)
78+
#### 4. Install [bower](http://bower.io/)
3079

3180
```
3281
npm install -g bower
3382
```
3483

35-
to install bower components
84+
to install bower components:
3685
```
3786
bower install
3887
```
3988

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
4198

4299
```
43100
// starts webserver with live reload

0 commit comments

Comments
 (0)