# Guides and Tutorials

- [About NodeGui](tutorial/about.md)
- [Setting up the Development Environment](tutorial/development-environment.md)
  - [Setting up macOS](tutorial/development-environment.md#setting-up-macos)
  - [Setting up Windows](tutorial/development-environment.md#setting-up-windows)
  - [Setting up Linux](tutorial/development-environment.md#setting-up-linux)
  - [Choosing an Editor](tutorial/development-environment.md#a-good-editor)
- [Creating your First App](tutorial/first-app.md)
  - [Hello World](tutorial/first-app.md#Hello-World)
  - [NodeGui Development in a Nutshell](tutorial/first-app.md#NodeGui-development-in-a-nutshell)
  - [Running Your App](tutorial/first-app.md#running-your-app)

// BOOK MARK - TODO AFTER THIS

- [Application Architecture](tutorial/application-architecture.md)
  - [Main and Renderer Processes](tutorial/application-architecture.md#main-and-renderer-processes)
  - [Using NodeGui's APIs](tutorial/application-architecture.md#using-NodeGui-apis)
  - [Using Node.js APIs](tutorial/application-architecture.md#using-nodejs-apis)
  - [Using Native Node.js Modules](tutorial/using-native-node-modules.md)
- Adding Features to Your App
  - [Notifications](tutorial/notifications.md)
  - [Recent Documents](tutorial/recent-documents.md)
  - [Application Progress](tutorial/progress-bar.md)
  - [Custom Dock Menu](tutorial/macos-dock.md)
  - [Custom Windows Taskbar](tutorial/windows-taskbar.md)
  - [Custom Linux Desktop Actions](tutorial/linux-desktop-actions.md)
  - [Keyboard Shortcuts](tutorial/keyboard-shortcuts.md)
  - [Offline/Online Detection](tutorial/online-offline-events.md)
  - [Represented File for macOS BrowserWindows](tutorial/represented-file.md)
  - [Native File Drag & Drop](tutorial/native-file-drag-drop.md)
  - [Offscreen Rendering](tutorial/offscreen-rendering.md)
  - [Supporting macOS Dark Mode](tutorial/mojave-dark-mode-guide.md)
- [Testing and Debugging](tutorial/application-debugging.md)
  - [Debugging the Main Process](tutorial/debugging-main-process.md)
  - [Debugging the Main Process with Visual Studio Code](tutorial/debugging-main-process-vscode.md)
  - [Using Selenium and WebDriver](tutorial/using-selenium-and-webdriver.md)
  - [Testing on Headless CI Systems (Travis, Jenkins)](tutorial/testing-on-headless-ci.md)
  - [DevTools Extension](tutorial/devtools-extension.md)
  - [Automated Testing with a Custom Driver](tutorial/automated-testing-with-a-custom-driver.md)
- [Distribution](tutorial/application-distribution.md)
  - [Supported Platforms](tutorial/support.md#supported-platforms)
  - [Code Signing](tutorial/code-signing.md)
  - [Mac App Store](tutorial/mac-app-store-submission-guide.md)
  - [Windows Store](tutorial/windows-store-guide.md)
  - [Snapcraft](tutorial/snapcraft.md)
- [Security](tutorial/security.md)
  - [Reporting Security Issues](tutorial/security.md#reporting-security-issues)
  - [Chromium Security Issues and Upgrades](tutorial/security.md#chromium-security-issues-and-upgrades)
  - [NodeGui Security Warnings](tutorial/security.md#NodeGui-security-warnings)
  - [Security Checklist](tutorial/security.md#checklist-security-recommendations)
- [Updates](tutorial/updates.md)
  - [Deploying an Update Server](tutorial/updates.md#deploying-an-update-server)
  - [Implementing Updates in Your App](tutorial/updates.md#implementing-updates-in-your-app)
  - [Applying Updates](tutorial/updates.md#applying-updates)
- [Getting Support](tutorial/support.md)

## Detailed Tutorials

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

- [Installing NodeGui](tutorial/installation.md)
  - [Proxies](tutorial/installation.md#proxies)
  - [Custom Mirrors and Caches](tutorial/installation.md#custom-mirrors-and-caches)
  - [Troubleshooting](tutorial/installation.md#troubleshooting)
- NodeGui Releases & Developer Feedback
  - [Versioning Policy](tutorial/NodeGui-versioning.md)
  - [Release Timelines](tutorial/NodeGui-timelines.md)
  - [App Feedback Program](tutorial/app-feedback-program.md)
- [Packaging App Source Code with asar](tutorial/application-packaging.md)
  - [Generating asar Archives](tutorial/application-packaging.md#generating-asar-archives)
  - [Using asar Archives](tutorial/application-packaging.md#using-asar-archives)
  - [Limitations](tutorial/application-packaging.md#limitations-of-the-node-api)
  - [Adding Unpacked Files to asar Archives](tutorial/application-packaging.md#adding-unpacked-files-to-asar-archives)
- [Testing Widevine CDM](tutorial/testing-widevine-cdm.md)
- [Using Pepper Flash Plugin](tutorial/using-pepper-flash-plugin.md)

---

- [Glossary of Terms](glossary.md)

## API References

- [Synopsis](api/synopsis.md)
- [Process Object](api/process.md)
- [Supported Chrome Command Line Switches](api/chrome-command-line-switches.md)
- [Environment Variables](api/environment-variables.md)
- [Breaking API Changes](api/breaking-changes.md)

### Custom DOM Elements:

- [`File` Object](api/file-object.md)
- [`<webview>` Tag](api/webview-tag.md)
- [`window.open` Function](api/window-open.md)
- [`BrowserWindowProxy` Object](api/browser-window-proxy.md)

### Modules for the Main Process:

- [app](api/app.md)
- [autoUpdater](api/auto-updater.md)
- [BrowserView](api/browser-view.md)
- [BrowserWindow](api/browser-window.md)
- [contentTracing](api/content-tracing.md)
- [dialog](api/dialog.md)
- [globalShortcut](api/global-shortcut.md)
- [inAppPurchase](api/in-app-purchase.md)
- [ipcMain](api/ipc-main.md)
- [Menu](api/menu.md)
- [MenuItem](api/menu-item.md)
- [net](api/net.md)
- [netLog](api/net-log.md)
- [powerMonitor](api/power-monitor.md)
- [powerSaveBlocker](api/power-save-blocker.md)
- [protocol](api/protocol.md)
- [screen](api/screen.md)
- [session](api/session.md)
- [systemPreferences](api/system-preferences.md)
- [TouchBar](api/touch-bar.md)
- [Tray](api/tray.md)
- [webContents](api/web-contents.md)

### Modules for the Renderer Process (Web Page):

- [desktopCapturer](api/desktop-capturer.md)
- [ipcRenderer](api/ipc-renderer.md)
- [remote](api/remote.md)
- [webFrame](api/web-frame.md)

### Modules for Both Processes:

- [clipboard](api/clipboard.md)
- [crashReporter](api/crash-reporter.md)
- [nativeImage](api/native-image.md)
- [shell](api/shell.md)

## Development

See [development/README.md](development/README.md)