{"id":18347641,"url":"https://github.com/botpress/botpress-electron","last_synced_at":"2025-04-09T23:25:57.198Z","repository":{"id":41984374,"uuid":"449425391","full_name":"botpress/botpress-electron","owner":"botpress","description":"This converts the Botpress binaries into a binary downloader / installer / runner ","archived":false,"fork":false,"pushed_at":"2022-07-25T18:06:50.000Z","size":2180,"stargazers_count":0,"open_issues_count":14,"forks_count":2,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-02-15T14:47:34.485Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/botpress.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-01-18T19:47:50.000Z","updated_at":"2022-04-07T17:26:27.000Z","dependencies_parsed_at":"2022-09-06T09:22:08.520Z","dependency_job_id":null,"html_url":"https://github.com/botpress/botpress-electron","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":"electron-react-boilerplate/electron-react-boilerplate","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/botpress%2Fbotpress-electron","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/botpress%2Fbotpress-electron/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/botpress%2Fbotpress-electron/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/botpress%2Fbotpress-electron/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/botpress","download_url":"https://codeload.github.com/botpress/botpress-electron/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248127813,"owners_count":21052294,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-05T21:14:34.903Z","updated_at":"2025-04-09T23:25:57.175Z","avatar_url":"https://github.com/botpress.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Install\n\nClone the repo and install dependencies:\n\n```bash\ngit clone https://github.com/botpress/botpress-electron\ncd botpress-electron\nnvm install\nnpm i\n```\nGet 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.\n\n## Starting Development\n\nStart the app in the `dev` environment:\n\n```bash\nnpm start\n```\n\n## Packaging for Production\n\nTo package apps for the local platform:\n\n```bash\nnpm run package\n```\n\nOR for debugging production instances\n\n```bash\nnpm run package:dev\n```\n\nBinaries will be found in ./release/build/Botpress@version_number-mac.dmg\n\n\n## Configuration\n\nTo set the botpress binary version :\n\nIn 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)\n\nTo set the release version (for example : Botpress_12.26.10.exe) : \n\nSet the \"version\" parameter in the release/app/package.json's \"version\".\n\n## Release \n\nGithub release drafts are created whenever main is updated and there is no existing version found in release/app/package.json's \"version\".\n\nSee 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. \n\n\n## A bit about versioning\n\nBotpress-electron generally follows botpress versions. \n\nIf 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 \u0026 letter, like this : 12.26.10-a.\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbotpress%2Fbotpress-electron","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbotpress%2Fbotpress-electron","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbotpress%2Fbotpress-electron/lists"}