README.md

svelte-electron-ts-todo-app using svelte stores

Template for apps written with Electron, Svelte and Typescript.

The template does hot module replacement and reloads electron on main process file changes out of the box. It also follows some good security practices, such as Content-Security-Policy meta tags in html, context isolation set to true, remote modules set to false etc.

Get started

To create a new project based on this template you must first clone the repo and then delete the folder .git:

git clone https://github.com/d-subrahmanyam/svelte-electron-ts-todo-app MyAppName
cd MyAppName
rm -rf .git

Note that you will need to have Node.js installed.

Install the dependencies...

pnpm i

...then start coding in dev mode:

pnpm start

The start script spins up Rollup in watch mode with a Rollup-Plugin-Serve instance serving the frontend static files on localhost:5000 and a nodemon server to watch for file changes related to the main electron process.

Contributing

In order to lint the code you run:

pnpm run lint

In order to prettify the code you run:

pnpm run format

You should run the following command, which runs lint and then format, on your contributed code:

pnpm run preversion

before creating a pull request.

All suggestions are welcome!

Licence

This project is licensed under the terms described in LICENSE.

🤝 A big thanks to fuzzc0re. A lot of the config and project structure are inspiration from his repo - electron-svelte-typescript