{"id":21748746,"url":"https://github.com/bryanl/octant-electron","last_synced_at":"2026-04-11T12:03:54.578Z","repository":{"id":66319993,"uuid":"234989870","full_name":"bryanl/octant-electron","owner":"bryanl","description":null,"archived":false,"fork":false,"pushed_at":"2020-07-07T03:03:27.000Z","size":1343,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-21T02:26:54.287Z","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/bryanl.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-01-20T00:38:06.000Z","updated_at":"2020-01-20T00:38:53.000Z","dependencies_parsed_at":"2023-05-01T06:15:47.945Z","dependency_job_id":null,"html_url":"https://github.com/bryanl/octant-electron","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bryanl%2Foctant-electron","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bryanl%2Foctant-electron/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bryanl%2Foctant-electron/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bryanl%2Foctant-electron/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bryanl","download_url":"https://codeload.github.com/bryanl/octant-electron/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bryanl%2Foctant-electron/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259182150,"owners_count":22818061,"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-26T08:14:59.278Z","updated_at":"2026-04-11T12:03:54.513Z","avatar_url":"https://github.com/bryanl.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Angular Logo](https://www.vectorlogo.zone/logos/angular/angular-icon.svg)](https://angular.io/) [![Electron Logo](https://www.vectorlogo.zone/logos/electronjs/electronjs-icon.svg)](https://electronjs.org/)\n\n![Maintained][maintained-badge]\n[![Travis Build Status][build-badge]][build]\n[![Make a pull request][prs-badge]][prs]\n[![License](http://img.shields.io/badge/Licence-MIT-brightgreen.svg)](LICENSE.md)\n\n[![Watch on GitHub][github-watch-badge]][github-watch]\n[![Star on GitHub][github-star-badge]][github-star]\n[![Tweet][twitter-badge]][twitter]\n\n# Introduction\n\nBootstrap and package your project with Angular 8 and Electron (Typescript + SASS + Hot Reload) for creating Desktop applications.\n\nCurrently runs with:\n\n- Angular v8.2.14\n- Electron v7.1.7\n- Electron Builder v21.2.0\n\nWith this sample, you can :\n\n- Run your app in a local development environment with Electron \u0026 Hot reload\n- Run your app in a production environment\n- Package your app into an executable file for Linux, Windows \u0026 Mac\n\n/!\\ Hot reload only pertains to the renderer process. The main electron process is not able to be hot reloaded, only restarted.\n\n/!\\ Angular 8.x CLI needs Node 10.9 or later to works correctly.\n\n## Getting Started\n\nClone this repository locally :\n\n``` bash\ngit clone https://github.com/maximegris/angular-electron.git\n```\n\nInstall dependencies with npm :\n\n``` bash\nnpm install\n```\n\nThere is an issue with `yarn` and `node_modules` when the application is built by the packager. Please use `npm` as dependencies manager.\n\n\nIf you want to generate Angular components with Angular-cli , you **MUST** install `@angular/cli` in npm global context.\nPlease follow [Angular-cli documentation](https://github.com/angular/angular-cli) if you had installed a previous version of `angular-cli`.\n\n``` bash\nnpm install -g @angular/cli\n```\n\n## To build for development\n\n- **in a terminal window** -\u003e npm start\n\nVoila! You can use your Angular + Electron app in a local development environment with hot reload !\n\nThe application code is managed by `main.ts`. In this sample, the app runs with a simple Angular App (http://localhost:4200) and an Electron window.\nThe Angular component contains an example of Electron and NodeJS native lib import.\nYou can disable \"Developer Tools\" by commenting `win.webContents.openDevTools();` in `main.ts`.\n\n## Included Commands\n\n|Command|Description|\n|--|--|\n|`npm run ng:serve:web`| Execute the app in the browser |\n|`npm run build`| Build the app. Your built files are in the /dist folder. |\n|`npm run build:prod`| Build the app with Angular aot. Your built files are in the /dist folder. |\n|`npm run electron:local`| Builds your application and start electron\n|`npm run electron:linux`| Builds your application and creates an app consumable on linux system |\n|`npm run electron:windows`| On a Windows OS, builds your application and creates an app consumable in windows 32/64 bit systems |\n|`npm run electron:mac`|  On a MAC OS, builds your application and generates a `.app` file of your application that can be run on Mac |\n\n**Your application is optimised. Only /dist folder and node dependencies are included in the executable.**\n\n## You want to use a specific lib (like rxjs) in electron main thread ?\n\nYES! You can do it! Just by importing your library in npm dependencies section (not **devDependencies**) with `npm install --save`. It will be loaded by electron during build phase and added to your final package. Then use your library by importing it in `main.ts` file. Quite simple, isn't it ?\n\n## Browser mode\n\nMaybe you want to execute the application in the browser with hot reload ? Just run `npm run ng:serve:web`.\n**Note that you can't use Electron or NodeJS native libraries in this case.** Please check `providers/electron.service.ts` to watch how conditional import of electron/Native libraries is done.\n\n## Branch \u0026 Packages version\n\n- Angular 4 \u0026 Electron 1 : Branch [angular4](https://github.com/maximegris/angular-electron/tree/angular4)\n- Angular 5 \u0026 Electron 1 : Branch [angular5](https://github.com/maximegris/angular-electron/tree/angular5)\n- Angular 6 \u0026 Electron 3 : Branch [angular6](https://github.com/maximegris/angular-electron/tree/angular6)\n- Angular 7 \u0026 Electron 3 : Branch [angular7](https://github.com/maximegris/angular-electron/tree/angular7)\n- Angular 8 \u0026 Electron 7 : (master)\n\n[build-badge]: https://travis-ci.org/maximegris/angular-electron.svg?branch=master\u0026style=style=flat-square\n[build]: https://travis-ci.org/maximegris/angular-electron\n[license-badge]: https://img.shields.io/badge/license-Apache2-blue.svg?style=style=flat-square\n[license]: https://github.com/maximegris/angular-electron/blob/master/LICENSE.md\n[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square\n[prs]: http://makeapullrequest.com\n[github-watch-badge]: https://img.shields.io/github/watchers/maximegris/angular-electron.svg?style=social\n[github-watch]: https://github.com/maximegris/angular-electron/watchers\n[github-star-badge]: https://img.shields.io/github/stars/maximegris/angular-electron.svg?style=social\n[github-star]: https://github.com/maximegris/angular-electron/stargazers\n[twitter]: https://twitter.com/intent/tweet?text=Check%20out%20angular-electron!%20https://github.com/maximegris/angular-electron%20%F0%9F%91%8D\n[twitter-badge]: https://img.shields.io/twitter/url/https/github.com/maximegris/angular-electron.svg?style=social\n[maintained-badge]: https://img.shields.io/badge/maintained-yes-brightgreen\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbryanl%2Foctant-electron","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbryanl%2Foctant-electron","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbryanl%2Foctant-electron/lists"}