Skip to content

The core that powers WebCatalog, Singlebox and Clovery.

License

Notifications You must be signed in to change notification settings

nguyenchu2306/neutron

 
 

Repository files navigation

Neutron License: MPL 2.0

macOS (x64) Linux (x64) Windows (x64)
macOS (x64) Linux (x64) Windows (x64)
macOS (arm64) Linux (arm64) Windows (arm64)
macOS (arm64) Linux (arm64) Windows (arm64)

This powers the Neutron (Electron)-based apps you install from WebCatalog.


Development

This repository only contains the source code of the Neutron - the core that powers the apps created with WebCatalog. If you'd like to contribute to the WebCatalog app, check out https://github.com/webcatalog/webcatalog-app.

# 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=
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 the dependencies
yarn

# Run development mode
yarn electron-dev

# Package template app as zip file
yarn dist

About

The core that powers WebCatalog, Singlebox and Clovery.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%