Miss any of our Open RFC calls?Watch the recordings here! »

electroner

4.0.8 • Public • Published

electroner

electroner

Support me on Patreon Buy me a book PayPal Ask me anything Version Downloads Get help on Codementor

Buy Me A Coffee

Start ElectronJS apps from Node.js.

💡 If you're using 4.x.x, you have to manually install electron since this is not a dependency of electroner anymore, but it is used by it.

☁️ Installation

# Using npm 
npm install --save electroner
 
# Using yarn 
yarn add electroner

📋 Example

const electroner = require("electroner");
 
// Start the Electron app
electroner(`${__dirname}/app/index.js`, {
     "enable-transparent-visuals": true
   , "disable-cpu": true
});

❓ 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

electroner(options, callback)

Starts the Electron process.

Params

  • Object options: The path to the main script or an object interpreted by oargv and optional fields:

  • cwd (String): An optional key representing directory where the electron process should be executed.

  • Function callback: The callback function.

Return

  • Process The Electron process.

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

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

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

  • Support me on 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! ❤️

💫 Where is this library used?

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

  • hey-you (by Zac Anger)—Unmaintained: hey, you
  • instagram-chat (by nemanjan00)—Instagram Chat Application
  • photon-browser—A tiny web browser based on Photon and Electron.
  • simple-cam (by Zac Anger)—Very simple webcam viewer for desktop.

📜 License

MIT © Ionică Bizău

Install

npm i electroner

DownloadsWeekly Downloads

11

Version

4.0.8

License

MIT

Unpacked Size

8.5 kB

Total Files

4

Last publish

Collaborators

  • avatar