Skip to content

Commit c15c62a

Browse files
authored
Merge pull request #2684 from Azure/dpwatrous/lerna-update
Windows developer experience improvements
2 parents 709ea98 + f0a1f32 commit c15c62a

File tree

6 files changed

+6985
-8576
lines changed

6 files changed

+6985
-8576
lines changed

.editorconfig

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,6 @@ trim_trailing_whitespace = true
99

1010
[*.{yml,json,bicep}]
1111
indent_size = 2
12+
13+
[package*.json]
14+
end_of_line = lf

.gitattributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
* text=auto
2+
package*.json text eol=lf

docs/setup.md

Lines changed: 31 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,44 @@
22

33
The following are instructions for building and running Batch Explorer in a development environment.
44

5-
1. Install dependencies:
5+
1. Check prerequisites
6+
7+
Make sure the following are installed:
8+
9+
- Node.js 16 or higher
10+
- Python 3.6 or higher
11+
12+
**On Windows:**
13+
14+
Make sure Node.js is [configured to use the Visual Studio Build Tools](https://github.com/nodejs/node-gyp#on-windows).
15+
16+
Next, ensure that long path support is enabled in the registry by running the following command:
17+
18+
```shell
19+
New-ItemProperty -Path "HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem" -Name "LongPathsEnabled" -Value 1 -PropertyType DWORD -Force
20+
```
21+
22+
Also enable Git's long path support:
23+
24+
```shell
25+
git config --global core.longpaths true
26+
```
27+
28+
2. Install dependencies:
629
730
```shell
831
npm install
932
npm run dev-setup
1033
pip install -r python/requirements.txt
1134
```
1235
13-
2. Build the repository:
36+
3. Build the repository:
1437
1538
```shell
1639
npm run build
1740
```
1841
19-
## Running Batch Explorer Desktop Application
42+
## Run Batch Explorer in dev mode
2043
2144
```shell
2245
npm run launch:desktop # Open the dev server, Electron app and all packages in watch mode
@@ -32,11 +55,11 @@ Please also take a look at the [coding guidelines](coding-guidelines.md) for thi
3255
3356
If you're using VSCode (recommended) we suggest you use the following extensions:
3457

35-
* EditorConfig
36-
* ESLint
37-
* Prettier
38-
* Markdownlint
39-
* Stylelint
58+
- EditorConfig
59+
- ESLint
60+
- Prettier
61+
- Markdownlint
62+
- Stylelint
4063

4164
## Other useful commands
4265

0 commit comments

Comments
 (0)