nodeguy/extras/docs/README.md

Guides and Tutorials

• About NodeGui
• Setting up the Development Environment
  • Setting up macOS
  • Setting up Windows
  • Setting up Linux
  • Choosing an Editor
• Creating your First App
  • Hello World
  • NodeGui Development in a Nutshell
  • Running Your App

// BOOK MARK - TODO AFTER THIS

• Application Architecture
  • Main and Renderer Processes
  • Using NodeGui's APIs
  • Using Node.js APIs
  • Using Native Node.js Modules
• Adding Features to Your App
  • Notifications
  • Recent Documents
  • Application Progress
  • Custom Dock Menu
  • Custom Windows Taskbar
  • Custom Linux Desktop Actions
  • Keyboard Shortcuts
  • Offline/Online Detection
  • Represented File for macOS BrowserWindows
  • Native File Drag & Drop
  • Offscreen Rendering
  • Supporting macOS Dark Mode
• Testing and Debugging
  • Debugging the Main Process
  • Debugging the Main Process with Visual Studio Code
  • Using Selenium and WebDriver
  • Testing on Headless CI Systems (Travis, Jenkins)
  • DevTools Extension
  • Automated Testing with a Custom Driver
• Distribution
  • Supported Platforms
  • Code Signing
  • Mac App Store
  • Windows Store
  • Snapcraft
• Security
  • Reporting Security Issues
  • Chromium Security Issues and Upgrades
  • NodeGui Security Warnings
  • Security Checklist
• Updates
  • Deploying an Update Server
  • Implementing Updates in Your App
  • Applying Updates
• Getting Support

Detailed Tutorials

These individual tutorials expand on topics discussed in the guide above.

• Installing NodeGui
  • Proxies
  • Custom Mirrors and Caches
  • Troubleshooting
• NodeGui Releases & Developer Feedback
  • Versioning Policy
  • Release Timelines
  • App Feedback Program
• Packaging App Source Code with asar
  • Generating asar Archives
  • Using asar Archives
  • Limitations
  • Adding Unpacked Files to asar Archives
• Testing Widevine CDM
• Using Pepper Flash Plugin

---

• Glossary of Terms

API References

• Synopsis
• Process Object
• Supported Chrome Command Line Switches
• Environment Variables
• Breaking API Changes

Custom DOM Elements:

• File Object
• <webview> Tag
• window.open Function
• BrowserWindowProxy Object

Modules for the Main Process:

• app
• autoUpdater
• BrowserView
• BrowserWindow
• contentTracing
• dialog
• globalShortcut
• inAppPurchase
• ipcMain
• Menu
• MenuItem
• net
• netLog
• powerMonitor
• powerSaveBlocker
• protocol
• screen
• session
• systemPreferences
• TouchBar
• Tray
• webContents

Modules for the Renderer Process (Web Page):

• desktopCapturer
• ipcRenderer
• remote
• webFrame

Modules for Both Processes:

• clipboard
• crashReporter
• nativeImage
• shell

Development

See development/README.md