Ready-to-use Electron Configuration

for modern native desktop application

🦄 About 🦄

Minimum Viable Product: What is what we want?

The creation and deployment of a centralized sharable configuration, with the most well-known best practice approaches.

• What are the goals?
  • [X] Automation of publishing, testing, linting and packaging with GitLab-CI
  • [X] Provide understandable documentation for the use of the configuration
  • [X] Test the return of the configuration with unit tests and the validation of the configuration structure with smoke tests
  • [X] For the greatest possible compatibility we provide TypeScript definitions
  • [X] Use the unified ESLint and Prettier configuration for static analysis of the source code
  • [X] Choose the known best practices to configure Electron to build Modern Native Desktop Apps uniformly

🚀 Getting Started 🚀

Project Links

• Homepage
• Documentation
• Repository
• Issues

💪 Installation 💪

yarn add @bootcamp-project/electron-config

or

npm install @bootcamp-project/electron-config

🤩 Usage 🤩

See @bootcamp-project/electron-config preselections

Best practice Electron Config Example

# Example comming soon!

⭐️ Features ⭐️

• TypeScript definitions (@types) included
• Smoke and Unit-tested modules
• Latest Dependencies preinstalled Batteries included!
• Security-first production-ready configurations by default
• Extensive documentation

😎 Built With 😎

🏆 Acknowledgements 🏆

Thanks for these awesome resources that were used during the development of the Bootcamp: Electron Configuration:

• Library: Electron
• How-to: RTFM.page: Mocha + Chai
• How-to: RTFM.page: TypeScript
• How-to: TBCP-Framework: Modern Native Desktop Application

📑 Changelog 📑

See CHANGELOG for more information.

📋 Roadmap 📋

See the open issues for a list of proposed features (and known issues).

🤝 Contribute 🤝

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

Please read the contribution guidelines first.

0. Give us a star, it's really important! 😅
1. Fork the Project: (git clone https://gitlab.com/the-bootcamp-project/configurations/electron.git)
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

📜 License 📜

See LICENSE for more information.

💌 Contact 💌

Bootcamp contributors - contributors @ bootcamp-project .com