Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: delete manager and update server_manager/README.md #1511

Merged
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 1 addition & 11 deletions commitlint.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,7 @@ module.exports = {
'scope-enum': [
2,
'always',
[
'devtools',
'devtools/build',
'docs',
'manager',
'manager/electron',
'manager/web',
'metrics_server',
'sentry_webhook',
'server',
],
['devtools', 'devtools/build', 'docs', 'metrics_server', 'sentry_webhook', 'server'],
],
},
};
66 changes: 1 addition & 65 deletions src/server_manager/README.md
daniellacosse marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -1,67 +1,3 @@
# Outline Manager

## Running

To run the Outline Manager Electron app:

```
npm run action server_manager/electron_app/start ${PLATFORM}
```

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 ${PLATFORM}
```

Where `${PLATFORM}` is one of `linux`, `macos`, `windows`.

## Development Server

To run the Outline Manager as a web app on the browser and listen for changes:

```
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

```
npm run action server_manager/web_app/start_gallery
```

Changes to UI components will be hot reloaded into the gallery.

## Debug an existing binary

You can run an existing binary in debug mode by setting `OUTLINE_DEBUG=true`.
This will enable the Developer menu on the application window.

## Packaging

To build the app binary:

```
npm run action server_manager/electron_app/build ${PLATFORM} -- --buildMode=[debug,release]
```

Where `${PLATFORM}` is one of `linux`, `macos`, `windows`.

The per-platform standalone apps will be at `build/electron_app/static/dist`.

- Windows: zip files. Only generated if you have [wine](https://www.winehq.org/download) installed.
- Linux: tar.gz files.
- macOS: dmg files if built from macOS, zip files otherwise.

> NOTE: If you are building for macOS, you may need to run `security unlock-keychain login.keychain` so electron-builder has access to your certificates.

## Error reporting

To enable error reporting through [Sentry](https://sentry.io/) for local builds, run:

```bash
export SENTRY_DSN=[Sentry development API key]
npm run action server_manager/electron_app/start ${PLATFORM}
```
> THIS PROJECT HAS MOVED TO A NEW LOCATION: Outline Manager is now part of the [Outline Apps](https://github.com/Jigsaw-Code/outline-apps/tree/master/server_manager) repository.
daniellacosse marked this conversation as resolved.
Show resolved Hide resolved
82 changes: 0 additions & 82 deletions src/server_manager/base.webpack.js

This file was deleted.

25 changes: 0 additions & 25 deletions src/server_manager/browser.webpack.js

This file was deleted.

Loading
Loading