Skip to content

Commit 7f312e6

Browse files
authored
Merge pull request #817 from complexdatacollective/update/ReadmeMd
updated the readme file by adding a new step in Development section
2 parents 36681f5 + 6148d02 commit 7f312e6

File tree

2 files changed

+291
-285
lines changed

2 files changed

+291
-285
lines changed

README.md

Lines changed: 28 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ git submodule update --init --recursive -f
3333

3434
3. Install NPM packages
3535

36-
```sh
37-
npm install
38-
```
36+
```sh
37+
npm install
38+
```
3939

4040
Note: for Apple Silicon users, you need to install the `electron` package manually:
4141

@@ -45,20 +45,21 @@ Note: for Apple Silicon users, you need to install the `electron` package manual
4545

4646
# Operation
4747

48-
|`npm run <script>`|Description|
49-
|------------------|-----------|
50-
|`start:architect:electron`|Serves your app for consumption by electron.|
51-
|`start:network-canvas:electron`|Serves network canvas for consumption by previewer.|
52-
|`electron:dev`|Runs electron window with contents of `start:architect:electron` and `start:network-canvas:electron`(must be run concurrently)|
53-
|`build`|Compiles assets and prepares app for production in the /build directory.|
54-
|`lint`|Lints js/scss|
55-
|`test`|Runs testing suite|
56-
|`preflight`|Runs linting & testing. Useful as a prepush/build hook|
57-
|`dist:mac`|Build and publish OS X verison|
58-
|`dist:linux`|Build and publish Linux version|
59-
|`dist:win`|Build and publish Windows version|
60-
|`dist:all`|Build and publish all platforms|
61-
|`update-submodules`|Update git submodules|
48+
| `npm run <script>` | Description |
49+
| ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
50+
| `start:architect:electron` | Serves your app for consumption by electron. |
51+
| `start:network-canvas:electron` | Serves network canvas for consumption by previewer. |
52+
| `preelectron:dev` | Copies the electron source to `./electron-dev` (must be run only when setting up the repo for the first time, or bumping the version number) |
53+
| `dev:electron` | Runs electron window with contents of `start:architect:electron` and `start:network-canvas:electron`(must be run concurrently) |
54+
| `build` | Compiles assets and prepares app for production in the /build directory. |
55+
| `lint` | Lints js/scss |
56+
| `test` | Runs testing suite |
57+
| `preflight` | Runs linting & testing. Useful as a prepush/build hook |
58+
| `dist:mac` | Build and publish OS X verison |
59+
| `dist:linux` | Build and publish Linux version |
60+
| `dist:win` | Build and publish Windows version |
61+
| `dist:all` | Build and publish all platforms |
62+
| `update-submodules` | Update git submodules |
6263

6364
### Bump version
6465

@@ -75,13 +76,18 @@ e.g.
7576
There are two additional tasks to enable development within an electron app natively:
7677

7778
1. `npm run start:architect:electron`: to start the webpack dev server
78-
- Note: must be running on port 3003.
79+
80+
- Note: must be running on port 3003.
81+
7982
1. `npm run start:network-canvas:electron`: to start the webpack dev server
80-
- Note: must be running on port 3000.
81-
2. `npm run electron:dev` (in another terminal session)
82-
1. Copies the electron source to `./electron-dev`
83-
2. Runs the electron app from there
8483

84+
- Note: must be running on port 3000.
85+
86+
2. `npm run preelectron:dev` Copies the electron source to `./electron-dev` (in another terminal session)
87+
88+
- Note: This step only needs to be taken when setting up the repo for the first time, or when bumping the version number.
89+
90+
3. `npm run dev:electron` Runs the electron app from there
8591

8692
## Application Structure
8793

0 commit comments

Comments
 (0)