Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jyapayne/Electrify

Unmaintained, do not use!
https://github.com/jyapayne/Electrify

Last synced: 3 months ago
JSON representation

Unmaintained, do not use!

Awesome Lists containing this project

README 

        
NOTICE

======



This app is unmaintained. I do not have the resources to work on it any longer and haven't for a long time. If anyone would like to sponsor this project or take up ownership from me, I'd be glad to do either.



Electrify

==============



[Releases (Downloads)](https://github.com/jyapayne/Electrify/releases)



What is it?

-----------



From the creator of [Web2Executable](https://github.com/jyapayne/Web2Executable) comes Electrify, another friendly command line and GUI application that can transform your Nodejs (or any other JS/HTML) app into a standalone executable. The difference is that it is now powered by [Electron](https://github.com/atom/electron) instead of NW.js. It can export to Mac OS X, Windows and Linux all from one platform, so no need to go out and buy expensive hardware.



It's powered by the very awesome project [Electron](https://github.com/atom/electron) and PySide, is open source, and is just dang awesome and easy to use.



If you have an idea for a feature, please create a new issue with a format like this: "Feature - My Awesome New Feature", along with a good description of what you'd like the feature to do.



On the other hand, if you have any annoyances with the application and want to contribute to making it better for everyone, please file an issue with "Annoyance:" as the first part of the title. Sometimes it's hard to know what is annoying for people and input is much appreciated :)



Features

--------



- Cross platform to Mac, Windows, Linux

- Working media out of the box (sound and video)

- Easy to use and straightforward

- Streamlined workflow from project -> working standalone exe

- Same performance as Google Chrome

- Works with Phaser; should work with other HTML5 game libraries

- Export web applications to all platforms from your current OS

- Ability to specify an Electron version to download

- Automatic insertion of icon files into Windows exe's or Mac Apps by filling out the icon fields as necessary

- A command line utility with functionality equivalent to the GUI. Useful for automated builds.

- Compression of executables with upx



Getting Started

---------------



###Using Prebuilt Binaries



When using the prebuilt binaries for Windows, Mac, or Ubuntu, there are NO dependencies or extra applications needed. Simply download Electrify for the platform of your choice, extract, and double click the app/exe/binary to start. This applies to both the command-line version and the GUI version.



**NOTE!**: Some people report needing the Microsoft Visual C++ 2008/2010 SP1 and regular Redistributable package. I don't have a machine to test this, but just know that you might need the package if the application won't open or spits out the following error:



```

Error: The application has failed to start because the side by side configuration is incorrect please see the application event log or use the command line sxstrace.exe tool for more detail.

```



### Run from Python Source



Requires the pyside library and Python 3.4 or higher. If you want to replace the icon in the Windows Exe's, this will do it automatically with the latest code if you have PIL or Pillow installed.



####GUI



Install dependencies:



```

pip install -r requirements.txt

```



Initiate submodules:



```

git submodule update --init --recursive

```



Run with:



```

python3.4 main.py

```



It's a pretty simple app. Just point it to the directory where your web application lives, customize the options (the two marked with a star are the only ones required) and then choose your export options. The app will export under YOUR_OUTPUT_DIR/YOUR_APP_NAME. 



####Command line interface



Dependencies: configobj (install with pip) and Pillow if you want icon replacement (not necessary)



Run the command_line.py with the --help option to see a list of export options. Optionally, if you don't want to install python, there are builds for Mac and Windows in the command_line_builds folder of this repository.



Example usage (if using the prebuilt binary, replace `python command_line.py` with the exe name):



```

python3.4 command_line.py /var/www/html/CargoBlaster/ --main html/index.html --export-to linux-x64 windows mac --width 900 --height 700 --electron-version 0.36.7

```



###GUI Instructions



To use Electrify:

  1. Choose a project folder with at least one html or php file. The name of the export application will be autogenerated from the folder that you choose, so change it if you so desire.

  2. Modify the options as needed.

  3. Choose at least one export platform and then the Export button should enable (as long as the field names marked with a star are filled out and all files in the fields exist).

  4. Click the export button and once it's done, click the "Open Export Folder" button to go to the folder where your exported project will be.



### Issues?



If you have an issue, please check the FAQ before filing an issue to see if it helps.



[FAQ](https://github.com/jyapayne/Electrify/wiki/FAQ)



### Additional Info



[Changelog](https://github.com/jyapayne/Electrify/wiki/Changelog)



[Screenshots](https://github.com/jyapayne/Electrify/wiki/Screenshots)



License

-------



The MIT License (MIT)



Copyright (c) 2015 SimplyPixelated



Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:



The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.



THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

SOFTWARE.