README.md

todesktop-quick-start

Clone and run for a quick way to see ToDesktop in action.

This is a minimal Electron application to get you started with ToDesktop.

Use this app along with @todesktop/cli

To Use

To clone and run this repository you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:

# Clone this repository
git clone https://github.com/ToDesktop/todesktop-quick-start
# Go into the repository
cd todesktop-quick-start
# Install dependencies
npm install
# Run the app
npm start

Note: If you're using Linux Bash for Windows, see this guide or use node from the command prompt.

Deployment

To deploy your application, run npm run release at the root of the project. This uses @todesktop/cli. Once it completes, URLs to download your desktop app will be shown in the command line.

Noteworthy changes from electron-quick-start

This template project is based on electron-quick-start but here are the important changes:

• todesktop.json contains some configuaration for ToDesktop. This includes pointing to icon.png as the app icon.
• main.js uses @todesktop/runtime. This handles auto-updates, etc.
• The npm run release command uses @todesktop/cli to deploy the app to production.
• The npm run build command uses @todesktop/cli to build the app for development use.
• The electron version in devDependencies is fixed (it doesn't start with ^ or ~). ToDesktop will use this version when building the app binaries.
• The author in package.json contains an email.
• Added productName in package.json.

More documentation

See https://docs.todesktop.com/cli/using-the-todesktop-cli

License

CC0 1.0 (Public Domain)