Skip to content
A tool that builds Network Canvas interviews.
JavaScript CSS HTML
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets/icons
build-resources
config
development-protocol @ 164e313
hooks
network-canvas @ 9680a5a
public
scripts
src
.babelrc
.editorconfig
.env
.eslintignore
.eslintrc.json
.gitattributes
.gitignore
.gitmodules
.sass-lint.yml
.travis.yml
CODE_OF_CONDUCT.md
LICENSE
README.md
dev-app-update.yml
jsdoc.conf.json
package-lock.json
package.json

README.md

Architect Build Status

FOSSA Status

Technologies used: ES6 (via Babel) React Redux Electron Cordova SCSS Jest (Testing suite) React Scripts

Operation

Installation

This repository assumes that npm is installed. If you don't have it installed, here are installation instructions.

  1. Clone this repo.
  2. Go into the repo directory
  3. Initialise the submodules npm run update-submodules

Available commands:

npm run <script> Description
start Serves your app at localhost:3000.
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

Supply a version mask with x for unchanged values:

npm run [x.x.1] [codename]

e.g.

npm run x.1.0 NameOfVersion

Development workflow in Electron

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.
  1. npm run start:network-canvas:electron: to start the webpack dev server
  • Note: must be running on port 3000.
  1. npm run electron:dev (in another terminal session)
  2. Copies the electron source to ./electron-dev
  3. Runs the electron app from there

Dev tools

Electron supports extensions to Chrome devtools such as Redux DevTools.

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.

Example: enabling Redux Devtools on macOS:

NC_DEVTOOLS_EXTENSION_PATH=~/Library/Application\ Support/Google/Chrome/Default/Extensions/lmhkpmbekcpmknklioeibfkpmmfibljd/2.15.2_0 npm run electron:dev

Environment options

AUTO_OPEN_BROWSER=false  # Set to false to disable browser auto open on `npm run start`, Default: true
WEBPACK_DEV_SERVER_PORT=3003  # Configure port for dev server. Default: 3003
CSC_IDENTITY_AUTO_DISCOVERY=false  # Set to false to disable signing builds (speeds up build process)

Application Structure

.
├── build                    # Prod assets
├── config                   # Project and build configurations (webpack, env config)
├── public                   # Static public assets
│   └── index.html           # Static entry point
├── src                      # Application source code
│   ├── index.js             # Application bootstrap and rendering
│   ├── routes.js            # App Route Definitions
│   ├── components           # Contains directories for components
│   ├── containers           # Contains directories for containers for native and base classes
│   ├── reducers             # Reducers for data stores
│   ├── ducks                # Middleware, modules (ducks-style with actions, reducers, and action creators), and store
│   └── utils                # Helpers and utils

License

FOSSA Status

You can’t perform that action at this time.