nimblehq / kmm-templates

KMM Templates

Kotlin Multiplatform Mobile (KMM) template to set up all KMM projects at Nimble

Features

TODO

Use the template

Prerequisites

• JDK: Java 17
• Kscript v4.0.3 or later.
• Android Studio with Kotlin Multiplatform Mobile plugin
• Xcode 13.3+

Please check this out for more details.

Set up a new project

Follow these steps to set up a new project from the template:

1. Clone or download this repository to your local machine.

2. Fetch all git sub-modules for the first time:

   $ git submodule update --init --recursive

3. Generate the new project by running the following command:

   $ ./make.sh --bundle-id [BUNDLE_ID] --bundle-id-staging [BUNDLE_ID_STAGING] --project-name [PROJECT_NAME] --ios-version [IOS_VERSION]

   For example,

   $ ./make.sh --bundle-id co.nimblehq.kmm.template --bundle-id-staging co.nimblehq.kmm.template.staging --project-name sample --ios-version 14.0

   To skip CI/CD service generating from iOS script, export this CI env:

   $ export CI=true

The generated project is in the [PROJECT_NAME] folder (such as /sample) and ready to build, run, and test 🎉

Contributing

See the contributing guide for detailed instructions on how to get started with our project.

License

This project is Copyright (c) 2014 and onwards Nimble. It is free software and may be redistributed under the terms specified in the LICENSE file.

About

This project is maintained and funded by Nimble.

We ❤️ open source and do our part in sharing our work with the community! See our other projects or hire our team to help build your product.

Want to join? Check out our Jobs!