/compose-desktop-template

Primary LanguageKotlinApache License 2.0Apache-2.0

compose-desktop-template

buildStatus latestVersion Twitter: theapache64

A compose desktop project template with MVVM, Dagger, Decompose and more

✨ Demo

What's included?

  • Architecture (MVVM) with Android-ish structure (SingleActivity)
  • Dependency Injection (Dagger2)
  • Navigation (Decompose)
  • Launcher Icons (for all platforms)
  • A separate data module
  • Testing (both unit tests and UI tests)
  • Theme
  • Logging
  • Font (GoogleSans)

⌨️ Use this template

  1. Click Use this template and create your repo

  2. Clone your repo and open it in an IDE

  3. Replace all myapp and My App instances with your app name. For this, you can use Control + Shift + R for the find and replace (IntelliJ)

OR

⌨️ Use the CLI

~$ sudo npm install -g create-compose-desktop-app
~$ create-compose-desktop-app
Enter project name :

Learn more here

✍️ Author

👤 theapache64

Feel free to ping me 😉

🤝 Contributing

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.

  1. Open an issue first to discuss what you would like to change.
  2. Fork the Project
  3. Create your feature branch (git checkout -b feature/amazing-feature)
  4. Commit your changes (git commit -m 'Add some amazing feature')
  5. Push to the branch (git push origin feature/amazing-feature)
  6. Open a pull request

Please make sure to update tests as appropriate.

❤ Show your support

Give a ⭐️ if this project helped you!

Patron Link Buy Me A Coffee

📝 License

Copyright © 2021 - theapache64

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

This README was generated by readgen ❤