You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Readme.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,12 +3,12 @@
3
3
4
4
**Note: BatchLabs is in beta. We don't provide any installer/packaged binaries as of now. You will need to build this app yourself.**
5
5
6
-
This is the readme for master branch is contains the latest changes. Stable might be slightly different[Stable readme](https://github.com/Azure/BatchLabs/tree/stable)
6
+
This is the readme for the 'master' branch which contains the latest changes, 'stable' may differ from this[Stable readme](https://github.com/Azure/BatchLabs/tree/stable)
7
7
8
8
## Description
9
9
10
-
Batch Labs is a tool to manage your Azure Batch accounts. The goal is to implement some great user experience that will help you debug, monitor and manage your pools, jobs and tasks.
11
-
It will also include expermiental features such as `No Code Job` in the aim to improve your Batch experience. We are open to any feedback, ideas and contribution you might have.
10
+
Batch Labs is a tool to manage your Azure Batch accounts. The goal is to implement a great user experience that will help you debug, monitor and manage your pools, jobs and tasks.
11
+
It will also include expermiental features such as `Batch Templates` in the aim to improve your Batch experience. We are open to any feedback, ideas and contributions you might have.
12
12
13
13
## Getting started
14
14
#### 1. Prerequisites
@@ -24,7 +24,7 @@ Move to the directory `cd BatchLabs`
24
24
```bash
25
25
yarn install
26
26
```
27
-
Note: You can also use `npm install` at your own risk. However please do not submit an issue if you didn't use `yarn install`. Yarn will make sure you have the exact same set of dependencies as everybody which remove any unexpected third party bugs problems.
27
+
Note: You can also use `npm install` at your own risk. However please do not submit an issue if you didn't use `yarn install`. Yarn will make sure you have the right set of dependencies, which reduces the likelihood of any unexpected build issues relating to third party packages.
28
28
29
29
#### 4. Build and run the application
30
30
```bash
@@ -44,7 +44,7 @@ npm run electron
44
44
[Dev docs](docs/readme.md)
45
45
46
46
For developers, you can set up a development environment as follows:
47
-
**Use `yarn install` instead of `npm install` this will makes sure everybody has the same exact set of depenencies[Migrating from npm to yarn](https://yarnpkg.com/lang/en/docs/migrating-from-npm/)**
47
+
**Use `yarn install` instead of `npm install`. This ensures a consistent build environment with the right set of dependencies[Migrating from npm to yarn](https://yarnpkg.com/lang/en/docs/migrating-from-npm/)**
48
48
49
49
Start the dev server
50
50
```bash
@@ -61,7 +61,7 @@ npm run dev-electron
61
61
62
62
The dev-server and dev-electron support hot reload for a better development experience. Simply saving a file will cause the UI to refresh to your updated changes.
63
63
64
-
*Note:* Changes to any files in the node client directory ('\client\') require restarting the application.
64
+
*Note:* Changes to any files in the node client directory ('src/client') require restarting the application.
65
65
66
66
If you're using VSCode (recommended) we suggest you use the following extensions:
67
67
* Debugger for Chrome
@@ -79,7 +79,7 @@ Please also take a look at the [coding guidelines](coding-guidelines.md) for thi
79
79
In vscode install the editorconfig extension
80
80
81
81
## Detailed commands:
82
-
**Magic command(Starts the server and electron in dev mode)**
82
+
**Magic command (starts the server and electron in dev mode)**
83
83
```
84
84
npm run dev
85
85
```
@@ -94,17 +94,17 @@ Run app
94
94
npm run electron
95
95
```
96
96
97
-
Run watch(This will build files on save)
97
+
Run watch (this will build files on save)
98
98
```
99
99
npm run watch
100
100
```
101
101
102
-
Run dev server(This will handle the refresh of files and later should have live reloead)
102
+
Run dev server (this will handle the refresh of files and later should have live reload)
103
103
```
104
104
npm run dev-server
105
105
```
106
106
107
-
Run dev electron(To use the dev server you need to run this)
107
+
Run dev electron (to use the dev server you need to run this)
0 commit comments