Skip to content

ptkdev-boilerplate/svelte-electron-boilerplate

main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
app
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

๐Ÿงฌ svelte-electron-boilerplate

v2.0.0 License: MIT Powered By Svelte Powered By Electron Language: TypeScript ECMAScript: 2019 Discord Server

Create a desktop app with this user friendly Svelte boilerplate for electron

This is a github template, you can fork it or use as template for start new project with this repository as hello-world. I hate start new project with empty template, often i missing correct configuration, readme instruction or i need of samples of code. Use this repository as template solve this problem.

๐ŸŽ 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
  • [โœ”๏ธ] User friendly 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

๐Ÿ”จ Developer Mode

๐Ÿ Run Project

  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

๐Ÿ’พ Setup Project

If you want replace all strings (example: package name, author, urls, etc...) in markdown file, source files and others files of this project you need edit setup.json with correct values and run npm run setup.

๐Ÿš€ Deploy

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: npm run release. Installers are available in build folder.

๐Ÿ“š 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 and url.

๐Ÿ‘จโ€๐Ÿ’ป Contributing

I โค๏ธ contributions! I will happily accept your pull request! (IMPORTANT: Only to nightly branch!) 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
  • Documentations and Translations have CC BY 4.0 License
Copyleft (c) 2021 Patryk Rzucidล‚o (@PTKDev) <support@ptkdev.io>