ionicabizau/electronify

:construction_worker: The simplest way to build Electron apps.

Electronify

The simplest way to build Electron apps.

Electron is amazing! Electronify makes its usage simpler by reusing the same code snippets in common apps.

☁️ Installation

# Using npm
npm install --save electronify

# Using yarn
yarn add electronify

📋 Example

const Electronify = require("electronify");

// Create the app
var app = Electronify(__dirname + "/app/index.html", {
    resizable: false
});

❓ Get Help

There are few ways to get help:

1. Please post questions on Stack Overflow. 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. 🐛
3. For direct and quick help, you can use Codementor. 🚀

📝 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.

😋 How to contribute

Have an idea? Found a bug? See how to contribute.

💖 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 🚀

• —I love books! I will remember you after years if you buy me one. 😁 📖

• —You can make one-time donations via PayPal. I'll probably buy a coffee tea. 🍵

• —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! ❤️

💫 Where is this library used?

If you are using this library in one of your projects, add it in this list. ✨

• magnesium
• photon-browser

📜 License

MIT © Ionică Bizău

electronify's Issues

Emit a event "up" before return the ElectronApp instance

Using eletronify I think I found a little bug. After call the Electronify function I tried to log the App .mainWindow object and it returns undefined. 😞

var Electronify = require('electronify');

var App = new Electronify(__dirname + '/index.html', {
  resizable: true
});

console.log(App.mainWindow); //undefined

I imagine that is because the fill of App depends of the ready event.

In my opinion this can be fixed just emitting a "up" (or other name) event before return the ElectronApp instance. Doing that will be easy knowing that the app module from electron extends EventEmmiter.

    //... code
    // Save the browser window
    App.mainWindow = new BrowserWindow(bwOpts);

    App.mainWindow.loadUrl("file://" + path);
    App.mainWindow.on("closed", function() {
        mainWindow = null;
    });

    App.emit('alive', App.mainWindow);

    return App;
}

What do you think @IonicaBizau ?

What is Electronify doing?

So... what is Eelctronify doing, really?