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
Network Canvas Architect is a survey design tool for the [Network Canvas](https://networkcanvas.com) suite of applications. It is built on [Electron](https://electronjs.org/) and [React](https://reactjs.org/).
4
+
5
+
**This tool is in maintainance mode.** We are not actively developing new features, but will continue to fix bugs and accept pull requests. Community contributions are very welcome!
6
+
7
+
See the [Network Canvas](https://networkcanvas.com) website for more information.
8
+
9
+
For questions and support, please visit the [Network Canvas User Community](https://community.networkcanvas.com/).
This project currently requires version `14.21.3` of node, and version `8.3.2` of npm. These are the only supported versions for this project.
34
+
3. Install NPM packages
19
35
20
-
As a convenience, the repository contains a `.node-version` file that enables convinient use of a node environment manager.
36
+
```sh
37
+
npm install
38
+
```
21
39
22
-
## Installation
23
-
This repository assumes that `npm` is installed. If you don't have it installed, here are [installation instructions](https://docs.npmjs.com/getting-started/installing-node).
40
+
Note: for Apple Silicon users, you need to install the `electron` package manually:
3. Enter the directory where the repository is cloned, and install the project dependencies by typing `npm install`.
29
-
4. Refer to the development tasks section below to learn how to test and build the app.
42
+
```sh
43
+
npm install electron --arch=x86
44
+
```
30
45
31
-
### Available commands:
46
+
#Operation
32
47
33
48
|`npm run <script>`|Description|
34
49
|------------------|-----------|
35
-
|`start`|Serves your app at `localhost:3000`.|
36
50
|`start:architect:electron`|Serves your app for consumption by electron.|
37
51
|`start:network-canvas:electron`|Serves network canvas for consumption by previewer.|
38
52
|`electron:dev`|Runs electron window with contents of `start:architect:electron` and `start:network-canvas:electron`(must be run concurrently)|
@@ -68,24 +82,6 @@ There are two additional tasks to enable development within an electron app nati
68
82
1. Copies the electron source to `./electron-dev`
69
83
2. Runs the electron app from there
70
84
71
-
#### Dev tools
72
-
73
-
Electron supports [extensions to Chrome devtools](https://electronjs.org/docs/tutorial/devtools-extension) such as Redux DevTools.
74
-
75
-
In the development environment, these will be loaded if you provide one or more paths to your extensions (semicolon-separated) in the `NC_DEVTOOLS_EXTENSION_PATH` environment variable. The electron docs describe how to find the filepath for an extension once installed.
76
-
77
-
Example: enabling Redux Devtools on macOS:
78
-
```bash
79
-
NC_DEVTOOLS_EXTENSION_PATH=~/Library/Application\ Support/Google/Chrome/Default/Extensions/lmhkpmbekcpmknklioeibfkpmmfibljd/2.15.2_0 npm run electron:dev
80
-
```
81
-
82
-
#### Environment options
83
-
84
-
```bash
85
-
AUTO_OPEN_BROWSER=false # Set to false to disable browser auto open on `npm run start`, Default: true
86
-
WEBPACK_DEV_SERVER_PORT=3003 # Configure port for dev server. Default: 3003
87
-
CSC_IDENTITY_AUTO_DISCOVERY=false # Set to false to disable signing builds (speeds up build process)
88
-
```
89
85
90
86
## Application Structure
91
87
@@ -104,7 +100,3 @@ CSC_IDENTITY_AUTO_DISCOVERY=false # Set to false to disable signing builds (spe
104
100
│ ├── ducks # Middleware, modules (ducks-style with actions, reducers, and action creators), and store
0 commit comments