Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ptkdev-boilerplate/svelte-spa-boilerplate
👔 Create single page application with this friendly Svelte boilerplate made with typescript and love. Perfect for your web/pwa, electron or cordova project
https://github.com/ptkdev-boilerplate/svelte-spa-boilerplate
create-svelte-app github-template single-page-app svelte-boilerplate svelte-framework svelte-single-page-app svelte-spa-template svelte-template typescript
Last synced: 7 days ago
JSON representation
👔 Create single page application with this friendly Svelte boilerplate made with typescript and love. Perfect for your web/pwa, electron or cordova project
- Host: GitHub
- URL: https://github.com/ptkdev-boilerplate/svelte-spa-boilerplate
- Owner: ptkdev-boilerplate
- License: other
- Created: 2021-03-18T22:45:15.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T23:32:08.000Z (2 months ago)
- Last Synced: 2024-10-30T01:52:23.671Z (2 months ago)
- Topics: create-svelte-app, github-template, single-page-app, svelte-boilerplate, svelte-framework, svelte-single-page-app, svelte-spa-template, svelte-template, typescript
- Language: TypeScript
- Homepage: https://npmjs.com/package/@ptkdev/svelte-spa-boilerplate
- Size: 1.17 MB
- Stars: 32
- Watchers: 5
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# 👔 svelte-spa-boilerplate
[](https://github.com/ptkdev-boilerplate/svelte-spa-boilerplate/blob/main/CHANGELOG.md) [](https://www.npmjs.com/package/@ptkdev/svelte-spa-boilerplate) [](https://github.com/ptkdev-boilerplate/svelte-spa-boilerplate/blob/main/LICENSE.md) [](https://svelte.dev/) [](https://www.typescriptlang.org/) [](https://github.com/tc39/ecma262) [](https://discord.ptkdev.io)
Create single page application with this user-friendly Svelte boilerplate made with typescript and love
This is a [github template](https://github.blog/2019-06-06-generate-new-repositories-with-repository-templates/), you can fork it or [use as template](https://github.com/ptkdev-boilerplate/svelte-spa-boilerplate/generate) 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!**
[](https://www.paypal.me/ptkdev) [](https://ko-fi.com/ptkdev) [](https://github.com/sponsors/ptkdev) [](https://www.patreon.com/join/ptkdev) [](https://ptk.dev/img/icons/menu/bitcoin_wallet.png) [](https://ptk.dev/img/icons/menu/ethereum_wallet.png)
## 📎 Menu
- 💡 [Features](#-features)
- 👔 [Screenshot](#-screenshot)
- 📚 [Documentation](#-documentation)
- 🔨 [Developer Mode](#-developer-mode)
- - 🏁 [Run Project](#-run-project)
- - 💾 [Setup Project](#-setup-project)
- 👨💻 [Contributing](#-contributing)
- 🐛 [Known Bugs](https://github.com/ptkdev-boilerplate/svelte-spa-boilerplate/issues?q=is%3Aopen+is%3Aissue+label%3Abug)
- 🍻 Community:
- 
Telegram ([🇬🇧 English](http://t.me/ptkdev_support) | [🇮🇹 Italian](http://t.me/ptkdev_support_italian))
- 
[Discord](http://discord.ptkdev.io) ([🇬🇧 English](https://discord.gg/jqUSGPKdmA) | [🇮🇹 Italian](https://discord.gg/SJFcbvG6RU) | [🇵🇱 Polish](https://discord.gg/25vg4VFhb7))
- 
[Twitter](http://twitter.com/ptkdevio)
## 💡 Features
- [✔️] Easy to use
- [✔️] MIT License
- [✔️] Themes compatible with boilerplate of Electron and Cordova
- [✔️] Browser sync, auto refresh, auto reload
- [✔️] Dark mode
- [✔️] 100% on Google Speedpage
- [✔️] User-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 ❤️)
### 🔖 TODO
- [✖️] PWA + Service Worker + Offline
- [✖️] Images LazyLoad
## 👔 Screenshot
[](https://raw.githubusercontent.com/ptkdev-boilerplate/svelte-spa-boilerplate/main/.github/assets/screenshot.png)
## 🔨 Developer Mode
#### 🏁 Run Project
1. Clone this repository or download [nightly](https://github.com/ptkdev-boilerplate/svelte-spa-boilerplate/archive/nightly.zip), [beta](https://github.com/ptkdev-boilerplate/svelte-spa-boilerplate/archive/beta.zip) or [stable](https://github.com/ptkdev-boilerplate/svelte-spa-boilerplate/archive/main.zip).
2. Run `npm install`
3. Run `npm run dev`
4. Run `http://localhost:5000`
#### 💾 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`.
## 📚 Documentation
Run `npm run docs`
## 👑 Backers and Sponsors
Thanks to all our backers! 🙏 Donate 3$ or more on [paypal](https://www.paypal.me/ptkdev), [ko-fi](https://ko-fi.com/ptkdev), [github](https://github.com/sponsors/ptkdev) or [patreon](https://www.patreon.com/join/ptkdev) and send me [email](mailto:[email protected]) with your avatar and url.
[](https://api.ptkdev.io/backers/sponsor1.html) [](https://api.ptkdev.io/backers/sponsor2.html) [](https://api.ptkdev.io/backers/sponsor-kofi1.html) [](https://api.ptkdev.io/backers/sponsor-kofi2.html) [](https://api.ptkdev.io/backers/sponsor-kofi3.html) [](https://api.ptkdev.io/backers/sponsor3.html) [](https://api.ptkdev.io/backers/sponsor4.html) [](https://api.ptkdev.io/backers/sponsor5.html) [](https://api.ptkdev.io/backers/sponsor6.html) [](https://api.ptkdev.io/backers/sponsor7.html) [](https://api.ptkdev.io/backers/sponsor8.html) [](https://api.ptkdev.io/backers/sponsor9.html) [](https://api.ptkdev.io/backers/sponsor10.html) [](https://api.ptkdev.io/backers/sponsor11.html) [](https://api.ptkdev.io/backers/sponsor12.html) [](https://api.ptkdev.io/backers/sponsor13.html) [](https://api.ptkdev.io/backers/sponsor14.html) [](https://api.ptkdev.io/backers/sponsor15.html) [](https://api.ptkdev.io/backers/backer1.html) [](https://api.ptkdev.io/backers/backer2.html) [](https://api.ptkdev.io/backers/backer3.html) [](https://api.ptkdev.io/backers/backer4.html) [](https://api.ptkdev.io/backers/backer5.html) [](https://api.ptkdev.io/backers/backer6.html) [](https://api.ptkdev.io/backers/backer7.html) [](https://api.ptkdev.io/backers/backer8.html) [](https://api.ptkdev.io/backers/backer9.html) [](https://api.ptkdev.io/backers/backer10.html) [](https://api.ptkdev.io/backers/backer11.html) [](https://api.ptkdev.io/backers/backer12.html) [](https://api.ptkdev.io/backers/backer13.html) [](https://api.ptkdev.io/backers/backer14.html) [](https://api.ptkdev.io/backers/backer15.html) [](https://api.ptkdev.io/backers/backer16.html) [](https://api.ptkdev.io/backers/backer17.html) [](https://api.ptkdev.io/backers/backer18.html) [](https://api.ptkdev.io/backers/backer19.html) [](https://api.ptkdev.io/backers/backer20.html) [](https://api.ptkdev.io/backers/backer21.html) [](https://api.ptkdev.io/backers/backer22.html) [](https://api.ptkdev.io/backers/backer23.html) [](https://api.ptkdev.io/backers/backer24.html) [](https://api.ptkdev.io/backers/backer25.html) [](https://api.ptkdev.io/backers/backer26.html) [](https://api.ptkdev.io/backers/backer27.html) [](https://api.ptkdev.io/backers/backer28.html) [](https://api.ptkdev.io/backers/backer29.html)
## 👨💻 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](https://allcontributors.org/docs/en/emoji-key)):
> 💰 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
[](https://ptk.dev/)
[](https://github.com/ptkdev/ptkdev-logger) [](https://github.com/ptkdev/all-shields-cli) [](https://github.com/ptkdev/chrome-extension-aspectratio219) [](https://availableon.badge.ptkdev.io/) [](https://github.com/ptkdev/json-token-replace) [](https://github.com/ptkdev/eslint-plugin-snakecasejs)
[](https://github.com/ptkdev-components) [](https://github.com/ptkdev/aboutmeinfo-telegram-bot) [](https://github.com/ptkdev/quizquickanswer-telegram-game-bot) [](https://t.me/gamebookchatbot) [](https://github.com/ptkdev/vscode-theme-dark-blood) [](https://github.com/sourcesense/joyce)
[](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#-installation)
## 💫 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](https://ptk.dev) ([@PTKDev](https://twitter.com/ptkdev)) <[[email protected]](mailto:[email protected])>
