1
- # 🚀 svelte-electron-boilerplate
1
+ # 🧬 svelte-electron-boilerplate
2
2
3
3
<!-- all-shields/header-badges:START -->
4
- [](https://github.com/ptkdev-boilerplate/svelte-electron-boilerplate/blob/main/CHANGELOG.md) [](https://www.npmjs.com/package/@ptkdev/svelte-electron-boilerplate) [](https://github.com/ptkdev-boilerplate/svelte-electron-boilerplate/blob/main/LICENSE.md) [](https://svelte.dev/) [](https://www.typescriptlang.org/) [](https://github.com/tc39/ecma262) [](https://discord.ptkdev.io)
4
+
5
+ [](https://github.com/ptkdev-boilerplate/svelte-electron-boilerplate/blob/main/CHANGELOG.md) [](https://www.npmjs.com/package/@ptkdev/svelte-electron-boilerplate) [](https://github.com/ptkdev-boilerplate/svelte-electron-boilerplate/blob/main/LICENSE.md) [](https://svelte.dev/) [](https://www.typescriptlang.org/) [](https://github.com/tc39/ecma262) [](https://discord.ptkdev.io)
6
+
5
7
<!-- all-shields/header-badges:END -->
6
8
7
9
Create a desktop app with this friendly Svelte boilerplate for electron
@@ -11,29 +13,66 @@ Create a desktop app with this friendly Svelte boilerplate for electron
11
13
> 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!**
12
14
13
15
<!-- all-shields/sponsors-badges:START -->
14
- [ ![ Donate Paypal] ( https://img.shields.io/badge/donate-paypal-005EA6.svg?style=flat&logo=paypal )] ( https://www.paypal.me/ptkdev ) [ ![ Donate Ko-Fi] ( https://img.shields.io/badge/donate-ko--fi-29abe0.svg?style=flat&logo=ko-fi )] ( https://ko-fi.com/ptkdev ) [ ![ Donate Github Sponsors] ( https://img.shields.io/badge/donate-sponsors-ea4aaa.svg?style=flat&logo=github )] ( https://github.com/sponsors/ptkdev ) [ ![ Donate Patreon] ( https://img.shields.io/badge/donate-patreon-F87668.svg?style=flat&logo=patreon )] ( https://www.patreon.com/ptkdev ) [ ![ Donate Bitcoin] ( https://img.shields.io/badge/donate-35jQmZCy4nsxoMM3QPFrnZePDVhdKaHMRH-E38B29.svg?style=flat&logo=bitcoin )] ( ) [ ![ Donate Ethereum] ( https://img.shields.io/badge/donate-0x8b8171661bEb032828e82baBb0B5B98Ba8fBEBFc-4E8EE9.svg?style=flat&logo=ethereum )] ( )
16
+
17
+ [ ![ Donate Paypal] ( https://img.shields.io/badge/donate-paypal-005EA6.svg?style=flat&logo=paypal )] ( https://www.paypal.me/ptkdev ) [ ![ Donate Ko-Fi] ( https://img.shields.io/badge/donate-ko--fi-29abe0.svg?style=flat&logo=ko-fi )] ( https://ko-fi.com/ptkdev ) [ ![ Donate Github Sponsors] ( https://img.shields.io/badge/donate-sponsors-ea4aaa.svg?style=flat&logo=github )] ( https://github.com/sponsors/ptkdev ) [ ![ Donate Patreon] ( https://img.shields.io/badge/donate-patreon-F87668.svg?style=flat&logo=patreon )] ( https://www.patreon.com/ptkdev ) [ ![ Donate Bitcoin] ( https://img.shields.io/badge/donate-35jQmZCy4nsxoMM3QPFrnZePDVhdKaHMRH-E38B29.svg?style=flat&logo=bitcoin )] ( ) [ ![ Donate Ethereum] ( https://img.shields.io/badge/donate-0x8b8171661bEb032828e82baBb0B5B98Ba8fBEBFc-4E8EE9.svg?style=flat&logo=ethereum )] ( )
18
+
15
19
<!-- all-shields/sponsors-badges:END -->
16
20
17
21
## 📎 Menu
18
22
19
23
- 💡 [ Features] ( #-features )
24
+ - 🚀 [ How to use] ( #-usage )
25
+ - 👔 [ Screenshot] ( #-screenshot )
26
+ - 📚 [ Documentation] ( #-documentation )
20
27
- 🔨 [ Developer Mode] ( #-developer-mode )
21
28
- 👨💻 [ Contributing] ( #-contributing )
22
29
- 🐛 [ Known Bugs] ( https://github.com/ptkdev-boilerplate/svelte-electron-boilerplate/issues?q=is%3Aopen+is%3Aissue+label%3Abug )
23
30
- 🍻 Community:
24
- - <img src =" https://raw.githubusercontent.com/ptkdev-boilerplate/svelte-electron -boilerplate/main/.github/assets/social_discord.png " height =" 18px " > [ Discord] ( http://discord.ptkdev.io ) ([ 🇬🇧 English Channel] ( https://discord.gg/YkMG26f ) | [ 🇮🇹 Italian Channel] ( https://discord.gg/HFtdBAJ ) | [ 🇵🇱 Polish Channel] ( https://discord.gg/TV5EXFd ) )
31
+ - <img src =" https://raw.githubusercontent.com/ptkdev-boilerplate/node-cli -boilerplate/main/.github/assets/social_discord.png " height =" 18px " > [ Discord] ( http://discord.ptkdev.io ) ([ 🇬🇧 English Channel] ( https://discord.gg/jqUSGPKdmA ) | [ 🇮🇹 Italian Channel] ( https://discord.gg/SJFcbvG6RU ) | [ 🇵🇱 Polish Channel] ( https://discord.gg/25vg4VFhb7 ) )
25
32
26
33
## 💡 Features
27
34
28
35
- [ ✔️] Easy to use
29
36
- [ ✔️] MIT License
37
+ - [ ✔️] Svelte SPA + Electron Desktop App
38
+ - [ ✔️] Browser sync, auto refresh, auto reload
39
+ - [ ✔️] Dark mode
40
+ - [ ✔️] 100% on Google Speedpage
41
+ - [ ✔️] Friendly boilerplate + Github templates
42
+ - [ ✔️] Powered by svelte framework
43
+ - [ ✔️] Without jQuery depencence
44
+ - [ ✔️] Typescript + TSPaths preconfigured
45
+ - [ ✔️] Userfriendly folders tree
46
+ - [ ✔️] Prettiers and ESLint preconfigured
47
+ - [ ✔️] all-contributors-cli and all-shields-cli preconfigured
48
+ - [ ✔️] JEST Test preconfigured
49
+ - [ ✔️] Full async code
50
+ - [ ✔️] Github and Vscode dotfiles preconfigured
51
+ - [ ✔️] Translations i18n: 🇬🇧 🇮🇹 🇵🇱 (Help me ❤️)
52
+
53
+ ## 👔 Screenshot
54
+
55
+ [ ![ WebComponent: SvelteWebComponentBoilerplate] ( https://raw.githubusercontent.com/ptkdev-boilerplate/svelte-electron-boilerplate/main/.github/assets/screenshot.png )] ( https://raw.githubusercontent.com/ptkdev-boilerplate/svelte-electron-boilerplate/main/.github/assets/screenshot.png )
56
+
57
+ ## 🚀 Usage: Deploy
58
+
59
+ 1 . Clone this repository or download [ nightly] ( https://github.com/ptkdev-boilerplate/svelte-electron-boilerplate/archive/nightly.zip ) , [ beta] ( https://github.com/ptkdev-boilerplate/svelte-electron-boilerplate/archive/beta.zip ) or [ stable] ( https://github.com/ptkdev-boilerplate/svelte-electron-boilerplate/archive/main.zip ) .
60
+ 2 . Run ` npm install `
61
+ 3 . For create desktop application insaller (exe, dmg or appImage) run:
62
+
63
+ - Windows: ` npm run build-win ` or ` npm run build-win-32bit `
64
+ - Linux: ` npm run build-lnx `
65
+ - Mac: ` npm run build-mac ` (Only on Apple machine)
66
+
67
+ ...or try build all with: ` nom run build ` . Installers are available in ` build ` folder.
30
68
31
69
## 🔨 Developer Mode
32
70
33
71
1 . Clone this repository or download [ nightly] ( https://github.com/ptkdev-boilerplate/svelte-electron-boilerplate/archive/nightly.zip ) , [ beta] ( https://github.com/ptkdev-boilerplate/svelte-electron-boilerplate/archive/beta.zip ) or [ stable] ( https://github.com/ptkdev-boilerplate/svelte-electron-boilerplate/archive/main.zip ) .
34
72
2 . Run ` npm install `
35
73
3 . Run ` npm run dev `
36
74
4 . Run ` npm run dev:electron `
75
+ 5 . Run ` http://localhost:5000 `
37
76
38
77
## 📚 Documentation
39
78
@@ -70,19 +109,27 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
70
109
## 🦄 Other Projects
71
110
72
111
<!-- all-shields/projects-badges1:START -->
73
- [ ![ ] ( https://img.shields.io/badge/💻%20My-Portfolio-3498db.svg?style=flat&logo= )] ( https://ptk.dev/ )
112
+
113
+ [ ![ ] ( https://img.shields.io/badge/💻%20My-Portfolio-3498db.svg?style=flat&logo= )] ( https://ptk.dev/ )
114
+
74
115
<!-- all-shields/projects-badges1:END -->
75
116
76
117
<!-- all-shields/projects-badges2:START -->
77
- [ ![ ] ( https://img.shields.io/badge/🦒%20Tools-Node%20Logger-9b59b6.svg?style=flat&logo= )] ( https://github.com/ptkdev/ptkdev-logger ) [ ![ ] ( https://img.shields.io/badge/🦌%20Tools-All%20Shields%20CLI-9b59b6.svg?style=flat&logo= )] ( https://github.com/ptkdev/all-shields-cli ) [ ![ ] ( https://img.shields.io/badge/🖥️%20Tools-Aspect%20Ratio%2021:9-9b59b6.svg?style=flat&logo= )] ( https://github.com/ptkdev/chrome-extension-aspectratio219 ) [ ![ ] ( https://img.shields.io/badge/🛡%20Tools-Badges:%20Available%20on-9b59b6.svg?style=flat&logo= )] ( https://availableon.badge.ptkdev.io/ ) [ ![ ] ( https://img.shields.io/badge/🐾%20Tools-JSON%20Token%20Replace-9b59b6.svg?style=flat&logo= )] ( https://github.com/ptkdev/json-token-replace ) [ ![ ] ( https://img.shields.io/badge/🐍%20Tools-ESLint:%20snakecasejs-9b59b6.svg?style=flat&logo= )] ( https://github.com/ptkdev/eslint-plugin-snakecasejs )
118
+
119
+ [ ![ ] ( https://img.shields.io/badge/🦒%20Tools-Node%20Logger-9b59b6.svg?style=flat&logo= )] ( https://github.com/ptkdev/ptkdev-logger ) [ ![ ] ( https://img.shields.io/badge/🦌%20Tools-All%20Shields%20CLI-9b59b6.svg?style=flat&logo= )] ( https://github.com/ptkdev/all-shields-cli ) [ ![ ] ( https://img.shields.io/badge/🖥️%20Tools-Aspect%20Ratio%2021:9-9b59b6.svg?style=flat&logo= )] ( https://github.com/ptkdev/chrome-extension-aspectratio219 ) [ ![ ] ( https://img.shields.io/badge/🛡%20Tools-Badges:%20Available%20on-9b59b6.svg?style=flat&logo= )] ( https://availableon.badge.ptkdev.io/ ) [ ![ ] ( https://img.shields.io/badge/🐾%20Tools-JSON%20Token%20Replace-9b59b6.svg?style=flat&logo= )] ( https://github.com/ptkdev/json-token-replace ) [ ![ ] ( https://img.shields.io/badge/🐍%20Tools-ESLint:%20snakecasejs-9b59b6.svg?style=flat&logo= )] ( https://github.com/ptkdev/eslint-plugin-snakecasejs )
120
+
78
121
<!-- all-shields/projects-badges2:END -->
79
122
80
123
<!-- all-shields/projects-badges3:START -->
81
- [ ![ ] ( https://img.shields.io/badge/📸%20WebComponent-Instagram%20Widget-e74c3c.svg?style=flat&logo= )] ( https://github.com/ptkdev-components/webcomponent-instagram-widget ) [ ![ ] ( https://img.shields.io/badge/👑%20WebComponent-My%20Patreon%20Box-e74c3c.svg?style=flat&logo= )] ( https://github.com/ptkdev-components/webcomponent-patreon-box ) [ ![ ] ( https://img.shields.io/badge/🏞%20WebComponent-Carousel%20Slideshow-e74c3c.svg?style=flat&logo= )] ( https://github.com/ptkdev-components/webcomponent-carousel-slideshow )
124
+
125
+ [ ![ ] ( https://img.shields.io/badge/📸%20WebComponent-Instagram%20Widget-e74c3c.svg?style=flat&logo= )] ( https://github.com/ptkdev-components/webcomponent-instagram-widget ) [ ![ ] ( https://img.shields.io/badge/👑%20WebComponent-My%20Patreon%20Box-e74c3c.svg?style=flat&logo= )] ( https://github.com/ptkdev-components/webcomponent-patreon-box ) [ ![ ] ( https://img.shields.io/badge/🏞%20WebComponent-Carousel%20Slideshow-e74c3c.svg?style=flat&logo= )] ( https://github.com/ptkdev-components/webcomponent-carousel-slideshow )
126
+
82
127
<!-- all-shields/projects-badges3:END -->
83
128
84
129
<!-- all-shields/projects-badges4:START -->
85
- [ ![ ] ( https://img.shields.io/badge/🎨%20Themes-VSCode-f1c40f.svg?style=flat&logo= )] ( https://github.com/ptkdev/vscode-theme-dark-blood ) [ ![ ] ( https://img.shields.io/badge/📚%20Bot-GameBookChat-34495e.svg?style=flat&logo= )] ( https://t.me/gamebookchatbot ) [ ![ ] ( https://img.shields.io/badge/🤖%20Boilerplate-BOT-f368e0.svg?style=flat&logo= )] ( https://github.com/ptkdev-bot ) [ ![ ] ( https://img.shields.io/badge/🦄%20Boilerplate-Website%20/%20App-f368e0.svg?style=flat&logo= )] ( hhttps://github.com/ptkdev-boilerplate ) [ ![ ] ( https://img.shields.io/badge/💅%20App-Me%20in%20Gifs-2ecc71.svg?style=flat&logo= )] ( https://meingifs.pics/ ) [ ![ ] ( https://img.shields.io/badge/📱%20App-Stickers-2ecc71.svg?style=flat&logo= )] ( https://github.com/ptkdev/ptkdev-stickers#-install-free )
130
+
131
+ [](https://github.com/ptkdev/vscode-theme-dark-blood) [](https://t.me/gamebookchatbot) [](https://github.com/ptkdev-boilerplate?q=svelte) [](https://github.com/ptkdev-boilerplate?q=webcomponent) [](https://github.com/ptkdev-boilerplate?q=bot) [](https://github.com/ptkdev-boilerplate?q=node) [](https://meingifs.pics/) [](https://github.com/ptkdev/ptkdev-stickers#-install-free)
132
+
86
133
<!-- all-shields/projects-badges4:END -->
87
134
88
135
## 💫 License
0 commit comments