Skip to content
⚒ 💻 Electron + Bulma CSS + Cash DOM + Nunjucks Template Engine
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
configs
docs
logs
modules
tests
themes/default
translations
.all-contributorsrc
.editorconfig
.eslintignore
.eslintrc.json
.gitattributes
.gitignore
.gitmodules
.jshintrc
.npmignore
.pm2-process.json
CHANGELOG.md
LICENSE
README.md
app.js
app_electron.js
gulpfile.js
package.json

README.md

Yourprojectname

🎩 Yourprojectname

yourprojectdesc

🎁 Support: Donate

This project is free, open source and I try to provide excellent free support. Why donate? I work on open source projects several hours a week or in my spare time and try to keep it up to date and working. A lower donation would allow continuous development, ever better quality and the realization of this dream. THANK YOU!

🔖 Screenshot

💡 Features

Why? I like to have a solid starting point and have full control over it.

  • [✔️] Electron app (Boilerplate)
  • [✔️] Themes compatible with boilerplate of Electron and Cordova
  • [✔️] Easy to use, work and deploy
  • [✔️] Browser sync, auto refresh, auto reload
  • [❌] PWA and Service Worker (Not available in electron, in future? Let's hope so)
  • [✔️] Images LazyLoad
  • [✔️] Themes Switch
  • [✔️] Nightmode
  • [✔️] Multi language
  • [✔️] Switch language in app
  • [✔️] Template engine (nunjucks)
  • [✔️] Advanced logger
  • [✔️] Auto merge js, css (sass) in 1 file.
  • [✔️] Build exe, dmg and deb files

🔧 Run (Developer mode)

  1. Replace in all project yourprojectname.com string with your website url.
  2. Replace in all project Yourprojectname string with your website name (uppercase first letter - one word)
  3. Replace in all project yourprojectname string with your website name (all lowercase - one word)
  4. Replace in all project yourprojectdesc string with project description (less than 250char, escape double quote)
  5. Run npm install in ptkdev-electron-boilerplate folder.
  6. Remove .tpl suffix from config.js.tpl file in configs folder and fill it properly. Repeat this for all configs.
  7. Run npm run dev

See scripts on package.json for more feature and prod mode.

📦 Build (Windows, Linux, Mac OS)

  • npm run build-win generate windows .exe
  • npm run build-lnx generate linux .deb
  • npm run build-win generate mac .dmg

NOTE: Disable debug mode in config.js

📚 Documentation

  1. Run npm run docs

👑 Sponsors (max 10 available)

Support this project by becoming a sponsor. 🙏 Become a sponsor on patreon.

🦄 Backers

Thanks to all our backers! 🙏 Become a backer on patreon.

❤️ Contributing

I 💟 contributions! I will happily accept your pull request! Translations, grammatical corrections (GrammarNazi you are welcome! Yes my English is horrible, sorry), new modes, best css selectors, fix and new feature! 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
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!

📲 Tools

🐍 Sorry for snake_case

I love snake_case syntax sorry for this 😭 don't hate me.

💫 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) 2018-2019 Patryk Rzucidło (@PTKDev) <support@ptkdev.io>
You can’t perform that action at this time.