https://github.com/botpress/botpress-electron
This converts the Botpress binaries into a binary downloader / installer / runner
https://github.com/botpress/botpress-electron
Last synced: about 1 year ago
JSON representation
This converts the Botpress binaries into a binary downloader / installer / runner
- Host: GitHub
- URL: https://github.com/botpress/botpress-electron
- Owner: botpress
- License: mit
- Created: 2022-01-18T19:47:50.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-07-25T18:06:50.000Z (almost 4 years ago)
- Last Synced: 2025-02-15T14:47:34.485Z (over 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 2.08 MB
- Stars: 0
- Watchers: 4
- Forks: 2
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Install
Clone the repo and install dependencies:
```bash
git clone https://github.com/botpress/botpress-electron
cd botpress-electron
nvm install
npm i
```
Get your segment and sentry keys and put them into a .env file (see [.env.example](.env.example)). You'll need the other environment parameters if you want to build locally.
## Starting Development
Start the app in the `dev` environment:
```bash
npm start
```
## Packaging for Production
To package apps for the local platform:
```bash
npm run package
```
OR for debugging production instances
```bash
npm run package:dev
```
Binaries will be found in ./release/build/Botpress@version_number-mac.dmg
## Configuration
To set the botpress binary version :
In the main package.json set botpressVersion to the tag that you want (ex. v12_26_10 found here https://s3.amazonaws.com/botpress-binaries/index.html)
To set the release version (for example : Botpress_12.26.10.exe) :
Set the "version" parameter in the release/app/package.json's "version".
## Release
Github release drafts are created whenever main is updated and there is no existing version found in release/app/package.json's "version".
See the .env.example file for more information about what is needed for release (everything not written _DEV, or CI). You'll need to add these as secrets on Github repo. Note that despite the fact that Electron-builder's CSC_LINK and WIN_CSC_LINK ask for links, you can also convert your code signing certificates into base64 and use the strings.
## A bit about versioning
Botpress-electron generally follows botpress versions.
If something needs to be changed to fix an issue, it will usually happen after a binary release. What you can do and maintain compatibility with Semantic Versioning is append a dash & letter, like this : 12.26.10-a.