Skip to content
This repository has been archived by the owner on Jul 14, 2020. It is now read-only.

Latest commit

 

History

History
80 lines (49 loc) · 2.28 KB

DEVELOPMENT.md

File metadata and controls

80 lines (49 loc) · 2.28 KB
Raw

Development

This is only relevant for Stoplight engineers.

Setup

Dependencies
  • Stoplight Platform
  • Node >= 7
OS X / Linux

Install the dev deps listed above.

yarn install && cd app && yarn install && cd ..
yarn start
Building

Builds will be located in the /dist folder.

yarn build:production
Code Signing

This is useful: https://mkaz.blog/code/code-signing-a-windows-application/.

CSC_LINK, WIN_CSC_LINK, and CSC_KEY_PASSWORD must be set in your environment. For example:

Our mac cert is provided by apple developer program. Install it into your keychain, export it to .p12 from the keychain/login screen.

Our windows cert is provided by Digicert. Install it into your keychain, export it to .p12 from the keychain/login screen.

export CSC_LINK="~/Documents/Credentials/evario-cert/cert-mac.p12"
export WIN_CSC_LINK="~/Documents/Credentials/evario-cert/cert.p12"
export CSC_KEY_PASSWORD="123"
Releasing

GH_TOKEN needs to be set in your environment.

Code signing needs to be setup.

  1. Increment app/package.json version property.
  2. Build Stoplight Platform, replace app/build with newly built public files (just files/folders in the public directory).
yarn release:production

Environment Variables

  • The desktop app MUST bundle ALL if its own variables. It will not inherit variables from hosted stoplight since it now bundles all of its own assets.
  • Production environment variables are located in app/.env.
  • Development environment variables are located in app/development.env.
Adding a Variable
  1. Add its default production value (or set to empty string) to app/.env.
  2. Add its default development value (or set to empty string) to app/development.env.
  3. Add it to app/utils/config/index.js.

Project Structure

Notable directories and files:

app/main.js

The entry point to the application. This is run when it starts. This file opens a new Electron window, loading either a local instance of the API Dashboard (in development), or a remote instance of the dashboard.

app/utils/browser/index.js

This is a pre-script, run before the remote dashboard is loaded. Here, we set a global Electron variable, making several native node modules available to the Stoplight platform.