https://github.com/ionicabizau/electronify
:construction_worker: The simplest way to build Electron apps.
https://github.com/ionicabizau/electronify
hacktoberfest
Last synced: over 1 year ago
JSON representation
:construction_worker: The simplest way to build Electron apps.
- Host: GitHub
- URL: https://github.com/ionicabizau/electronify
- Owner: IonicaBizau
- License: mit
- Created: 2015-10-16T13:39:59.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2025-02-13T19:05:16.000Z (over 1 year ago)
- Last Synced: 2025-04-04T13:44:41.024Z (over 1 year ago)
- Topics: hacktoberfest
- Language: JavaScript
- Size: 27.3 KB
- Stars: 119
- Watchers: 6
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](#)
# Electronify
[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [](https://github.com/IonicaBizau/ama) [](https://www.npmjs.com/package/electronify) [](https://www.npmjs.com/package/electronify) [](https://www.codementor.io/@johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)
> The simplest way to build Electron apps.
[Electron](https://github.com/atom/electron) is amazing! Electronify makes its usage simpler by reusing the same code snippets in common apps.
[](#)
## :cloud: Installation
```sh
# Using npm
npm install --save electronify
# Using yarn
yarn add electronify
```
## :clipboard: Example
```js
const Electronify = require("electronify");
// Create the app
var app = Electronify(__dirname + "/app/index.html", {
resizable: false
});
```
## :question: Get Help
There are few ways to get help:
1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:
3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
## :memo: Documentation
### `Electronify(path, options)`
Creates a new browser window based on Electron.
#### Params
- **String** `path`: The path to the HTML file.
- **Object** `options`: An object representing the browser window options. It has the following defaults:
- `width` (Number): The window width (default: `800`).
- `height` (Number): The window height (default: `600`).
#### Return
- **ElectronApp** The Electron app object extended with the following fields:
- `mainWindow` (BrowserWindow): The browser window that was created.
## :yum: How to contribute
Have an idea? Found a bug? See [how to contribute][contributing].
## :sparkling_heart: Support my projects
I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,
this takes time. You can integrate and use these projects in your applications *for free*! You can even change the source code and redistribute (even resell it).
However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:
- Starring and sharing the projects you like :rocket:
- [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:
- [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
- [![Support me on Patreon][badge_patreon]][patreon]—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
- **Bitcoin**—You can send me bitcoins at this address (or scanning the code below): `1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6`
Thanks! :heart:
## :dizzy: Where is this library used?
If you are using this library in one of your projects, add it in this list. :sparkles:
- `magnesium`
- `photon-browser`
## :scroll: License
[MIT][license] © [Ionică Bizău][website]
[license]: /LICENSE
[website]: https://ionicabizau.net
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md
[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg
[patreon]: https://www.patreon.com/ionicabizau
[amazon]: http://amzn.eu/hRo9sIZ
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW