https://github.com/el3um4s/memento-svelte-electron-typescript

Template to create a desktop app with Svelte, TailwindCSS, Electron and TypeScript (with electron-updater, electron-reload and electron-builder)
https://github.com/el3um4s/memento-svelte-electron-typescript

electron electron-app electron-svelte electronjs svelte svelte-js sveltejs tailwind tailwind-css tailwindcss typescript

Last synced: 4 months ago
JSON representation

Template to create a desktop app with Svelte, TailwindCSS, Electron and TypeScript (with electron-updater, electron-reload and electron-builder)

• Host: GitHub
• URL: https://github.com/el3um4s/memento-svelte-electron-typescript
• Owner: el3um4s
• License: mit
• Created: 2021-06-24T16:20:25.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-02-03T21:47:51.000Z (almost 2 years ago)
• Last Synced: 2024-09-29T01:23:42.791Z (4 months ago)
• Topics: electron, electron-app, electron-svelte, electronjs, svelte, svelte-js, sveltejs, tailwind, tailwind-css, tailwindcss, typescript
• Language: TypeScript
• Homepage:
• Size: 1.62 MB
• Stars: 45
• Watchers: 3
• Forks: 11
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# MEMENTO - Svelte, TailwindCSS, Electron and TypeScript

![screenshot-01](github-images/screenshot-01.png)

Template to create a desktop app with Svelte, TailwindCSS, Electron and TypeScript (with electron-updater, electron-reload and electron-builder)

## Get Started

This is a project template for [Svelte](https://svelte.dev) and [Electron](https://www.electronjs.org/) apps. It lives at https://github.com/el3um4s/memento-svelte-electron-typescript.

To create a new project based on this template using [degit](https://github.com/Rich-Harris/degit):

```bash

npx degit el3um4s/memento-svelte-electron-typescript svelte-app

cd svelte-app

```

Then install the dependencies with

```bash

npm install

```

_Note that you will need to have [Node.js](https://nodejs.org) installed._

## Command

For development purpose:

- `npm run nodemon`: auto restart Electron on change

- `npm run dev`: auto reload the web page when you change Svelte files

For publish purpose:

- `npm run out:win`: create an exe file for Windows

- `npm run publish:win`: publish the app on GitHub

For test purpose:

- `npm run test`: test the app

- `npm run test:show-trace`: open the saved testing trace using [Playwright CLI](https://playwright.dev/docs/trace-viewer)

## Notes

I'm blogging about the development process in these posts:

- [Svelte, Electron & TypeScript](https://www.patreon.com/posts/svelte-electron-52952074)

- [Electron and TypeScript: how to use ipcMain and ipcRenderer](https://www.patreon.com/posts/electron-and-how-53505039)

- [SvelteKit & Electron](https://www.patreon.com/posts/sveltekit-53840008)