To run the Outline Manager Electron app:
npm run action server_manager/electron_app/start
To run the Outline Manager Electron app with a development build (code not minified):
BUILD_ENV=development npm run action server_manager/electron_app/start
To run the Outline Manager as a web app on the browser and listen for changes:
npm run action server_manager/web_app/start
We have a server app to for quickly iterating on UI components. To spin it up, run
npm run action server_manager/web_app/start_gallery
Changes to UI components will be hot reloaded into the gallery.
You can run an existing binary in debug mode by setting OUTLINE_DEBUG=true.
This will enable the Developer menu on the application window.
To build the app binary:
npm run action server_manager/electron_app/package_${PLATFORM}
Where ${PLATFORM} is one of linux, macos, only_windows.
The per-platform standalone apps will be at build/electron_app/static/dist.
- Windows: zip files. Only generated if you have wine installed.
- Linux: tar.gz files.
- macOS: dmg files if built from macOS, zip files otherwise.
To perform a release, use
npm run action server_manager/electron_app/release
This will perform a clean and reinstall all dependencies to make sure the build is not tainted.
To enable error reporting through Sentry for local builds, run:
export SENTRY_DSN=[Sentry development API key]
npm run action server_manager/electron_app/startRelease builds on CI are configured with a production Sentry API key.