diff --git a/src/server_manager/README.md b/src/server_manager/README.md index a3d940bf..ac6bf08a 100644 --- a/src/server_manager/README.md +++ b/src/server_manager/README.md @@ -3,11 +3,13 @@ ## Running 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 ``` @@ -22,7 +24,7 @@ npm run action server_manager/web_app/start ## Gallery Server for UI Development -We have a server app to for quickly iterating on UI components. To spin it up, run +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 @@ -38,6 +40,7 @@ This will enable the Developer menu on the application window. ## Packaging To build the app binary: + ``` npm run action server_manager/electron_app/package_${PLATFORM} ``` @@ -53,6 +56,7 @@ The per-platform standalone apps will be at `build/electron_app/static/dist`. ## Releases To perform a release, use + ``` npm run action server_manager/electron_app/release ``` @@ -62,7 +66,8 @@ This will perform a clean and reinstall all dependencies to make sure the build ## Error reporting To enable error reporting through [Sentry](https://sentry.io/) for local builds, run: -``` bash + +```bash export SENTRY_DSN=[Sentry development API key] npm run action server_manager/electron_app/start ``` diff --git a/src/server_manager/electron_app/tsconfig.json b/src/server_manager/electron_app/tsconfig.json index 487d666a..7bf1a31b 100644 --- a/src/server_manager/electron_app/tsconfig.json +++ b/src/server_manager/electron_app/tsconfig.json @@ -5,17 +5,9 @@ "noImplicitAny": true, "module": "commonjs", "rootDir": ".", - "lib": [ - "dom", - "es2016" - ] + "lib": ["dom", "es2016"] }, - "include": [ - "*.ts", - "../types/*.d.ts" - ], - "exclude": [ - "node_modules" - ], + "include": ["*.ts", "../types/*.d.ts"], + "exclude": ["node_modules"], "compileOnSave": true } diff --git a/src/server_manager/tsconfig.json b/src/server_manager/tsconfig.json index 05a987ac..0cc57500 100644 --- a/src/server_manager/tsconfig.json +++ b/src/server_manager/tsconfig.json @@ -1,12 +1,10 @@ { "compilerOptions": { - "target": "es2018", + "target": "es2018" }, "extends": "../../tsconfig.json", "rootDir": ".", - "include": [ - "**/*.ts" - ], + "include": ["**/*.ts"], "exclude": [ "node_modules", "web_app/galery_app", diff --git a/src/server_manager/web_app/ui_components/licenses/README.md b/src/server_manager/web_app/ui_components/licenses/README.md index a0a1eb1a..dadd46f7 100644 --- a/src/server_manager/web_app/ui_components/licenses/README.md +++ b/src/server_manager/web_app/ui_components/licenses/README.md @@ -2,12 +2,12 @@ ## Steps -* `cd` to the root of your clone of this repo -* Ensure `node_modules` is up to date and only include dependencies of the Electron app by running `npm ci && npm run action server_manager/web_app/build` -* `cd src/server_manager` -* `npx generate-license-file --input package.json --output web_app/ui_components/licenses/licenses.txt` -* `cd web_app/ui_components/licenses` -* `cat db-ip_license.txt >> licenses.txt` +- `cd` to the root of your clone of this repo +- Ensure `node_modules` is up to date and only include dependencies of the Electron app by running `npm ci && npm run action server_manager/web_app/build` +- `cd src/server_manager` +- `npx generate-license-file --input package.json --output web_app/ui_components/licenses/licenses.txt` +- `cd web_app/ui_components/licenses` +- `cat db-ip_license.txt >> licenses.txt` Done!