{"id":13430247,"url":"https://github.com/railsware/bozon","last_synced_at":"2025-05-16T00:07:28.827Z","repository":{"id":8338963,"uuid":"57168287","full_name":"railsware/bozon","owner":"railsware","description":"🛠 Command line tool for building, testing and publishing modern Electron applications","archived":false,"fork":false,"pushed_at":"2023-10-06T20:18:48.000Z","size":4926,"stargazers_count":757,"open_issues_count":12,"forks_count":52,"subscribers_count":51,"default_branch":"master","last_synced_at":"2025-05-06T07:09:08.269Z","etag":null,"topics":["boilerplate","bozon","electron","electron-application","electron-applications","electron-builder","packaging","scaffold","scaffolding","spectron","testing","webpack"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/railsware.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2016-04-26T23:16:28.000Z","updated_at":"2025-03-25T11:58:15.000Z","dependencies_parsed_at":"2024-01-07T05:37:36.978Z","dependency_job_id":null,"html_url":"https://github.com/railsware/bozon","commit_stats":{"total_commits":554,"total_committers":12,"mean_commits":"46.166666666666664","dds":0.08844765342960292,"last_synced_commit":"3ee36fb7e17fda8d18a5f561a42c0c23691d4d8d"},"previous_names":[],"tags_count":75,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/railsware%2Fbozon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/railsware%2Fbozon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/railsware%2Fbozon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/railsware%2Fbozon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/railsware","download_url":"https://codeload.github.com/railsware/bozon/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254442854,"owners_count":22071878,"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":["boilerplate","bozon","electron","electron-application","electron-applications","electron-builder","packaging","scaffold","scaffolding","spectron","testing","webpack"],"created_at":"2024-07-31T02:00:51.417Z","updated_at":"2025-05-16T00:07:23.814Z","avatar_url":"https://github.com/railsware.png","language":"JavaScript","readme":"# bozon\n\u003e Command line tool for building, testing and publishing modern [Electron](http://electron.atom.io/) applications\n\n[![npm version](https://badge.fury.io/js/bozon.svg)](https://badge.fury.io/js/bozon)\n[![Actions Status](https://github.com/railsware/bozon/workflows/Node.js%20CI/badge.svg)](https://github.com/swiftyapp/swifty/actions)\n\nBozon is  a simple, easy to use tool that unifies the existing build tools for Electron development. Simplify building, compiling, running, testing, and packaging your Electron applications.\n\n\n## Features\n* **Scaffolding** - Generate ready to use project structure for your new Electron application.\n* **Running** - Run your electron application with **Hot Reload** in development environment.\n* **Testing** - Build Application for test env and run feature tests for your Electron application.\n* **Packaging** - Build, package and publish your Electron app for Mac, Windows and Linux platforms.\n\nBozon uses [Webpack](https://webpack.js.org) to bundle source code for **main** and **renderer** processes as well as **preload** script. It adds **webpack.config.js** file to your project so that you can further configure webpack, add new rules, loaders etc. [Jest](https://jestjs.io/) along with [Spectron](https://www.electronjs.org/spectron) are used to run your **unit** and **feature tests** within real Electron application. For **packaging** and **publishing** applications bozon uses [electron-builder](https://www.electron.build/) under the hood.\n\n![bozon_start](https://user-images.githubusercontent.com/695947/152010984-8599ae9d-5c5c-40ec-90c5-b2a6e4d07052.png)\n\n## Installation\n\n\n```bash\nnpm install -g bozon\n```\n\nBozon tool should be installed globally in order to be used for all your electron apps.\n\n## Scaffolding\n\nThen generate your new project:\n\n```bash\nbozon new [name]\n```\n\nThis will create a new directory `[name]` produce the following file structure:\n\n  * Use `--skip-install` option if you want to skip running `npm install`\n\n```\n  |--config/\n  |--resources/\n  |--src/\n  |  |--main/\n  |  |  |--index.js\n  |  |--preload/\n  |  |  |--index.js\n  |  |--renderer/git \n  |  |  |--index.html\n  |  |  |--images/\n  |  |  |--stylesheets/\n  |  |  |--javascripts/\n  |  |  |  |--index.js\n  |--test/\n  |--package.json\n```\n\n## Starting an application\n\n```bash\nbozon start\n```\n\nThis will compile Application source code to `./builds/development` directory and run your application from it.\n\n### Configuration\nBozon provides a way to define environment specific and platform specific configuration options. These multiple config files are being merged into one single `config` object during build. This `config` object is accessible via `CONFIG` variable in `main` process files of your application, so that you can use it in your code.\n```\n  |--config/\n  |  |--settings.json\n  |  |--environments/\n  |  |  |--development.json\n  |  |  |--production.json\n  |  |  |--test.json\n  |  |--platforms/\n  |  |  |--mac.json\n  |  |  |--linux.json\n  |  |  |--windows.json\n```\n\n## Testing\nBozon is using [Jest](https://jestjs.io/) and [Spectron](https://www.electronjs.org/spectron) for testing Electron applications. Both unit and integration tests should go to `./test` directory. Simply execute for running tests:\n\n```bash\nbozon test\n```\n\n## Packaging application\nPackaging Electron application is done by [electron-builder](https://www.npmjs.com/package/electron-builder) using settings in defined in `package.json` under `build` section.\nApplication source code is being compiled to `./builds/production/` directory, and packaged versions for different platforms go to `./packages` directory.\n\n```bash\nbozon package [mac|windows|linux]\n```\n\n## License\n\nMIT © Alex Chaplinsky\n","funding_links":[],"categories":["CoffeeScript","Boilerplates","JavaScript"],"sub_categories":["Tools","Samples"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frailsware%2Fbozon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frailsware%2Fbozon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frailsware%2Fbozon/lists"}