Klutter

Klutter is a framework and tool set which uses Flutter to create the frontend and Kotlin Multiplatform for the backend. The connective layer is generated by the Klutter framework. Klutter combines industry best practices for everything from app design to CICD into a single cohesive framework.

Plugins

Klutter - Adapter

Klutter - Config

The config plugin is used to configure the project. A fully configured plugin will do the following tasks:

1. Read the klutter.yaml file and write all properties to the root build.gradle.kts
2. Create a build.gradle.kts template
3. Merge all build.gradle.kts file with the template

A Klutter project should not be a multicomponent gradle project. Instead all modules should be standalone.This means at minimum the Flutter module (frontend) and the KMP module (backend). A typical Klutter project looks like:

project
│   settings.gradle.kts [1] 
│   build.gradle.kts [2]
│   klutter.yaml [3]
│ 
└───app-frontend (flutter)
│   settings.gradle.kts [4] 
│   build.gradle.kts [5]
│   └───android 
│   │   │   └───app
│   │   │       │ build.gradle [6]
│   └───lib
│   └───ios
│   
└───app-backend (kotlin multiplatform)
   └───common (shared module) 
        │ settings.gradle.kts [7]        
        │ build.gradle.kts [8]

(1) root settings.gradle.kts must not include sub modules (2) build.gradle.kts applies the plugin //todo

Contributing

Pull requests are welcome. Contact me at [email protected]

License

MIT License

Copyright (c) [2021] [Gillian Buijs]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.