Awesome
Neutron
Archived
This repository is archived. To help us better improve the product and protect our intellectual assets, the development has been moved to Photon, a new core with closed source code base.
Introduction
The source code of the Neutron - the core that powers:
- WebCatalog: https://webcatalog.io/webcatalog/
- Singlebox: https://webcatalog.io/singlebox/
- Clovery: https://webcatalog.io/clovery/
- Skywhale: https://webcatalog.io/skywhale/
Development
# clone the project:
git clone https://github.com/webcatalog/neutron.git
cd neutron
For the app to be fully functional, set these environment variables:
ELECTRON_APP_SENTRY_DSN=
ELECTRON_APP_GOOGLE_API_KEY=
REACT_APP_AMPLITUDE_API_KEY=
REACT_APP_ELASTIC_CLOUD_APP_SEARCH_SEARCH_KEY=
REACT_APP_ELASTIC_CLOUD_APP_SEARCH_API_ENDPOINT=
REACT_APP_ELASTIC_CLOUD_APP_SEARCH_ENGINE_NAME=
Modify public/app.json
to change template app configuration. For example:
{
"id": "gmail",
"name": "Gmail",
"url": "https://mail.google.com"
}
- Install dependencies:
yarn
. - Run development mode
- in
template (WebCatalog)
mode:yarn electron-dev
. - in
standalone
mode:yarn electron-dev:standalone
. - in
Mac App Store
mode:yarn electron-dev:mac-app-store
. - in
Microsoft Store
mode:yarn electron-dev:appx
. - in
Snap
mode:yarn electron-dev:snap
. - in
Skywhale (standalone)
mode:yarn electron-dev:standalone:skywhale
. - in
Skywhale (Mac App Store)
mode:yarn electron-dev:mac-app-store:skywhale
.
- in
Distribution
Release as/for:
- template:
yarn release:template
. - Mac App Store:
yarn release:mac-app-store
. - APPX (Microsoft Store):
yarn release:appx
. - standalone:
yarn release:standalone
.