Electron Scaffolding

Empty Electron MVC-style project that provides a basic structure for native cross-platform desktop apps. The project uses PhotonKit for Mac-style UI and Metro-UI-CSS for Windows-style UI.

Usage

1. Clone this repo by running git clone git@github.com:ricardoalcocer/electron_scaffolding.git
2. Go to newly created folder cd electron_scaffolding
3. Install dependencies by running npm install
4. Start the project by running npm start
5. Install asar npm install -g asar (to pack the source code into a single file)
6. Package the app by running npm run package-mac

Project structure

📁 assets
    📁 css
    📁 fonts
    📁 icons
        📁 darwin
            📄 icon.icns
        📁 png
            📄 16x16.png
            📄 1024x1024.png
        📁 win32
            📄 icon.ico
📁 bindings                         Code for view/controller binding
    📄 mainwindow.js
📁 controllers
    📄 mainwindow.js                Controller code
📁 lib                              Shared libraries
    📄 appfunctions.js                
📁 menus
    📄 mainwindow.js                Menu files
📁 views
    📁 darwin                       HTML and CSS for App Windows
        📄 mainwindow.html
        📄 mainwindow.css
    📁 linux
        📄 mainwindow.html
        📄 mainwindow.css
    📁 win32
        📄 mainwindow.html
        📄 mainwindow.css
📄 .gitignore
📄 main.js                          Main bootstrap script
📄 package.json
📄 README.md

Useful tools

• Put your app on the system tray
• Generate App Icons
• Blog post about app Icons issues
• App Security Considerations