Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Release/6.5.0 #816

Closed
wants to merge 2 commits into from
Closed

Release/6.5.0 #816

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dd28e2e
updated Installation section of Readme file (added 3 more steps and u…
mrkarimoff Sep 6, 2023
687e03c
updated Development section of Readme file and updated the Prerequisi…
mrkarimoff Sep 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 28 additions & 23 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ For questions and support, please visit the [Network Canvas User Community](http
### Prerequisites

- [Node.js](https://nodejs.org/en/) (v14.21.3)
- [npm](https://www.npmjs.com/) (v8.19.4)
- [npm](https://www.npmjs.com/) (v8.3.2)
- [Git](https://git-scm.com/)
- [Python](https://www.python.org/) (v3.10.12)

Expand All @@ -33,9 +33,9 @@ git submodule update --init --recursive -f

3. Install NPM packages

```sh
npm install
```
```sh
npm install
```

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

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

# Operation

|`npm run <script>`|Description|
|------------------|-----------|
|`start:architect:electron`|Serves your app for consumption by electron.|
|`start:network-canvas:electron`|Serves network canvas for consumption by previewer.|
|`electron:dev`|Runs electron window with contents of `start:architect:electron` and `start:network-canvas:electron`(must be run concurrently)|
|`build`|Compiles assets and prepares app for production in the /build directory.|
|`lint`|Lints js/scss|
|`test`|Runs testing suite|
|`preflight`|Runs linting & testing. Useful as a prepush/build hook|
|`dist:mac`|Build and publish OS X verison|
|`dist:linux`|Build and publish Linux version|
|`dist:win`|Build and publish Windows version|
|`dist:all`|Build and publish all platforms|
|`update-submodules`|Update git submodules|
| `npm run <script>` | Description |
| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `start:architect:electron` | Serves your app for consumption by electron. |
| `start:network-canvas:electron` | Serves network canvas for consumption by previewer. |
| `electron:dev` | Runs electron window with contents of `start:architect:electron` and `start:network-canvas:electron`(must be run concurrently) |
| `build` | Compiles assets and prepares app for production in the /build directory. |
| `lint` | Lints js/scss |
| `test` | Runs testing suite |
| `preflight` | Runs linting & testing. Useful as a prepush/build hook |
| `dist:mac` | Build and publish OS X verison |
| `dist:linux` | Build and publish Linux version |
| `dist:win` | Build and publish Windows version |
| `dist:all` | Build and publish all platforms |
| `update-submodules` | Update git submodules |

### Bump version

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

1. `npm run start:architect:electron`: to start the webpack dev server
- Note: must be running on port 3003.

- Note: must be running on port 3003.

1. `npm run start:network-canvas:electron`: to start the webpack dev server
- Note: must be running on port 3000.
2. `npm run electron:dev` (in another terminal session)
1. Copies the electron source to `./electron-dev`
2. Runs the electron app from there

- Note: must be running on port 3000.

2. `npm run preelectron:dev` (in another terminal session)

- Copies the electron source to `./electron-dev`

3. `npm run dev:electron` Runs the electron app from there

## Application Structure

Expand Down
2 changes: 1 addition & 1 deletion package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading