KMP Utilities

KMP Library Utilities is a Kotlin Multiplatform library that offers utility functions to simplify cross-platform development. It is designed to boost productivity with ready-to-use features across multiple target platforms.

Documentation

For more information, check the documentation:

• Date Time Utilities
• Document uri Launcher Utilities
• Utilities Permission
• Platform Context

Example

Coming soon...

Android

The Example Android App can be built and installed via Android Studio, or via command line by executing:

./gradlew installDebug

iOS

The iOS project is generated via:

./gradlew generateXcodeProject

Tip

./gradlew openXcode can be used to both generate the project and open it in Xcode.

In Xcode, configure signing, then run.

Contributing

We welcome contributions to improve this project! Please follow these steps to ensure a smooth collaboration:

1. Open an Issue

Before starting any work, kindly open an issue to discuss your proposed changes or additions. This helps us align on the direction and avoid duplicate efforts.

2. Fork the Repository

Once your issue has been reviewed and approved, fork the repository to your GitHub account. This allows you to make changes independently.

3. Create a New Branch

Create a new branch based on the main branch in your forked repository. Use a descriptive name for your branch, such as feature/add-new-component or bugfix/fix-login-error or dev/#issue-number.

git checkout main
git checkout -b feature/your-branch-name

4. Submit a Pull Request

Once your work is complete, push your changes to your forked repository and open a pull request (PR) to merge your branch into the main branch of the original repository. Include a clear description of the changes you’ve made and reference the related issue in your PR.

Note

Ensure your code adheres to the project’s coding standards and includes relevant tests or documentation updates.

5. Collaborate on Review

Be ready to respond to feedback or requested changes during the review process. This ensures your

Thank you for contributing and helping us improve this project! 😊

Find this library useful?

Support it by joining stargazers for this repository. Also, follow me on GitHub for more libraries! 🤩

You can always

License

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.