Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/actually-colab/desktop-launcher
The optional @electron desktop launcher that acts as a companion for the @actually-colab web application built by @jtaylorchang and @baileytincher
https://github.com/actually-colab/desktop-launcher
desktop electron ipython jupyter linux macos windows
Last synced: 5 days ago
JSON representation
The optional @electron desktop launcher that acts as a companion for the @actually-colab web application built by @jtaylorchang and @baileytincher
- Host: GitHub
- URL: https://github.com/actually-colab/desktop-launcher
- Owner: actually-colab
- License: bsd-3-clause
- Created: 2021-02-24T15:33:05.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2021-05-27T16:02:20.000Z (over 3 years ago)
- Last Synced: 2024-04-14T01:02:06.922Z (9 months ago)
- Topics: desktop, electron, ipython, jupyter, linux, macos, windows
- Language: TypeScript
- Homepage: https://actuallycolab.org
- Size: 3.91 MB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://github.com/actually-colab/desktop-launcher/actions/workflows/validation.yml)  [](https://lgtm.com/projects/g/actually-colab/desktop-launcher/context:javascript)  [](https://github.com/actually-colab/desktop-launcher)
[](https://opencollective.com/actuallycolab) [](https://www.patreon.com/actuallycolab) [](https://www.youtube.com/watch?v=ParNlHsbSrY) [](https://devpost.com/software/actually-colab-real-time-collaborative-jupyter-editor)
# desktop-launcher
### The Kernel
This process is started by the kernel hidden renderer process and communicates with the main process via IPC. Normally this is taken care of for you if you are using the desktop companion, but you may prefer to launch it manually if you run into issues or we don't support your platform.
#### Starting the Kernel Manually
```bash
jupyter notebook --NotebookApp.open_browser="False" --NotebookApp.allow_origin="*" --NotebookApp.token="CHOOSE A TOKEN VALUE"
```
Alternatively you can use `jupyter lab`:
```bash
jupyter lab --no-browser --NotebookApp.allow_origin="*" --NotebookApp.token="CHOOSE A TOKEN VALUE"
```
> Setting the CORS Access-Control-Allow-Origin to `*` is generally a bad practice for security reasons. This will allow any website or malicious agent to execute code against your machine if they know what to look for. Instead, use the following origins depending on if you are in development or production:
>
> - Development: `http://localhost:4000`
> - Production: `https://app.actuallycolab.org`
>
> Similarly, you should choose a secure value for the token to make sure malicious clients can't connect to execute code
#### Stopping the Kernel
Run the following command to stop the kernel process:
```bash
jupyter notebook stop
```
If the kernel is running on a port other than the default `8888`, you can add the port to the end of the command.
To get a list of running ports you can run the following:
```bash
jupyter notebook list
```
## Starting Development
```bash
yarn start
```
## Debugging Prod
To run the production package with devtools and a visible kernel window:
```bash
yarn cross-env DEBUG_PROD=true yarn package
```
## Packaging for Production
To package apps for the local platform:
```bash
yarn package
```
To package apps for all platforms:
```bash
yarn package:all
```
To notarize on macOS you need to create a file `macos.cred.sh` at the root of the project:
```bash
#!/bin/bash
export CI="true"
export APPLE_ID="email goes here"
export APPLE_ID_PASS="password goes here"
```
You may need an app specific password which you can generate on the AppleID webpage.
Then run the following command:
```bash
yarn package:notarize
```
## Docs
See [docs and guides here](https://docs.actuallycolab.org)
## Backers
Support us with monthly donations to help us continue development and keep the service free for all!
## Sponsors
Become a sponsor and we'll add your logo to our README and link to you on our website!
## Maintainers
- [Jeff Taylor-Chang](https://github.com/jtaylorchang)
- [Bailey Tincher](https://github.com/baileytincher)
## License
`@actually-colab/desktop-launcher` is [BSD-3-Clause licensed](./LICENSE)