/udio-prompt-crafter

UDIO prompt crafter

Primary LanguageTypeScript

UDIO Prompt Crafter - Electron Setup

This guide explains how to package and run this application as a standalone desktop app using Electron.

1. Install Dependencies

You'll need esbuild, electron, and electron-builder. Install them as development dependencies:

npm install

2. Configure package.json

The package.json file is already configured with the necessary scripts and settings.

  • main: The entry point dist/electron/main.js tells Electron where to find the main process script after building.
  • scripts:
    • npm run build: Bundles the application into the dist folder.
    • npm run start-electron: Builds the app and launches it in a development window.
    • npm run package: Creates an installer for your current operating system.
    • npm run package-win: Creates a Windows installer (.exe).
  • build: This section configures electron-builder.

Note: For custom application icons, you can create an assets directory with icon.ico (Windows), icon.icns (Mac), and icon.png (Linux), then add an icon property to the respective OS settings in the build section of package.json.

3. How to Run

  1. Build the application:

    npm run build

    This will create a dist folder with the bundled app.

  2. Run in development mode:

    npm run start-electron

    This will build the app and launch it with Electron.

  3. Package for Windows:

    npm run package-win

    This will create a Windows installer in a release folder.