Memento Svelte Electron Typescript

Overview

MEMENTO is a project template for creating desktop applications using Svelte, TailwindCSS, Electron, and TypeScript. It provides a starting point for developers to build their own desktop apps by combining the power of these technologies. The template includes features such as electron-updater, electron-reload, and electron-builder to make development, publishing, and testing easier.

Features

• Svelte: Utilize the Svelte framework to create reactive and efficient user interfaces.
• TailwindCSS: Use TailwindCSS for easy and customizable styling of the application.
• Electron: Build cross-platform desktop applications using Electron.
• TypeScript: Develop your application using TypeScript for better type safety and scalability.
• electron-updater: Easily add the ability to update your Electron app with the built-in electron-updater.
• electron-reload: Automatically reload the Electron window when changes are made during development.
• electron-builder: Simplify the process of building and packaging your Electron app for distribution.

Installation

To create a new project based on the MEMENTO template, follow these steps:

1. Clone the MEMENTO template repository using degit by running the following command:

npx degit el3um4s/memento-svelte-electron-typescript my-project

Replace my-project with the desired name for your project.

2. Navigate to the project directory:

cd my-project

3. Install the project dependencies:

npm install

Once the installation is complete, you can start developing your application using the provided scripts.

For development purposes, you can use the following scripts:

• npm run nodemon: Automatically restart Electron when changes are made.
• npm run dev: Auto-reload the web page when Svelte files are changed.

For publishing purposes, you can use the following scripts:

• npm run out:win: Create an .exe file for Windows.
• npm run publish:win: Publish the app on GitHub.

For testing purposes, you can use the following scripts:

• npm run test: Test the app.
• npm run test:show-trace: Open the saved testing trace using Playwright CLI.

Summary

MEMENTO is a project template that combines Svelte, TailwindCSS, Electron, and TypeScript to provide developers with a starting point for building desktop applications. With features like electron-updater, electron-reload, and electron-builder, developers can easily develop, publish, and test their applications. The provided installation guide helps users quickly set up a new project based on the MEMENTO template and start building their own desktop app.