Skip to content

ptkdev-boilerplate/svelte-electron-boilerplate

Repository files navigation

🧬 svelte-electron-boilerplate

v1.0.20210402 License: MIT Powered By Svelte Powered By Electron Language: TypeScript ECMAScript: 2019 Discord Server

Create a desktop app with this friendly Svelte boilerplate for electron

🎁 Support: Donate

This project is free, open source and I try to provide excellent free support. Why donate? I work on this project several hours in my spare time and try to keep it up to date and working. THANK YOU!

Donate Paypal Donate Ko-Fi Donate Github Sponsors Donate Patreon Donate Bitcoin Donate Ethereum

📎 Menu

💡 Features

  • [✔️] Easy to use
  • [✔️] MIT License
  • [✔️] Svelte SPA + Electron Desktop App
  • [✔️] Browser sync, auto refresh, auto reload
  • [✔️] Dark mode
  • [✔️] 100% on Google Speedpage
  • [✔️] Friendly boilerplate + Github templates
  • [✔️] Powered by svelte framework
  • [✔️] Without jQuery depencence
  • [✔️] Typescript + TSPaths preconfigured
  • [✔️] Userfriendly folders tree
  • [✔️] Prettiers and ESLint preconfigured
  • [✔️] all-contributors-cli and all-shields-cli preconfigured
  • [✔️] JEST Test preconfigured
  • [✔️] Full async code
  • [✔️] Github and Vscode dotfiles preconfigured
  • [✔️] Translations i18n: 🇬🇧 🇮🇹 🇵🇱 (Help me ❤️)

👔 Screenshot

WebComponent: SvelteWebComponentBoilerplate

🚀 Usage: Deploy

  1. Clone this repository or download nightly, beta or stable.
  2. Run npm install
  3. For create desktop application installer (exe, dmg or appImage) run:
  • Windows: npm run build-win or npm run build-win-32bit
  • Linux: npm run build-lnx
  • Mac: npm run build-mac (Only on Apple machine)

...or try build all with: nom run build. Installers are available in build folder.

🔨 Developer Mode

  1. Clone this repository or download nightly, beta or stable.
  2. Run npm install
  3. Run npm run dev
  4. Run npm run dev:electron

📚 Documentation

Run npm run docs

👑 Backers and Sponsors

Thanks to all our backers! 🙏 Donate 3$ or more on paypal, ko-fi, github or patreon and send me email with your avatar, name and web site url.

👨‍💻 Contributing

I ❤️ contributions! I will happily accept your pull request! Translations, grammatical corrections (GrammarNazi you are welcome! Yes my English is bad, sorry), etc... Do not be afraid, if the code is not perfect we will work together 👯 and remember to insert your name in .all-contributorsrc and package.json file.

Thanks goes to these wonderful people (emoji key):


Patryk Rzucidło

💻 🌍 📖 🐛

💰 In the future, if the donations allow it, I would like to share some of the success with those who helped me the most. For me open source is share of code, share development knowledges and share donations!

🦄 Other Projects

💫 License

  • Code and Contributions have MIT License
  • Images and logos have CC BY-NC 4.0 License (Freepik Premium License)
  • Documentations and Translations have CC BY 4.0 License