Skip to main content
Version: 3.x

Introduction

Introduction​

This SDK aims to facilitate the integration of Miam eCommerce to any grocery shopping mobile application.

It implements a series of components that can be re-styled to your standards, and injected into your app. Miam Components interact with each other and take care of the communication with Miam API. Using this SDK, you should not need to communicate with Miam API directly from your app.

3 steps integration​

The integration of the SDK into your app will take three steps:

  1. Initialization : define the few mapping functions the SDK needs to interact with your app ( push products to basket, retrieve the user unique id...)
  2. Components injection : fill your app with Miam components wherever relevant (recipe cards in search results grids, recipes catalog on a dedicated page...)
  3. Styling : apply your own stylesheets, globally at the SDK level, and specifically for each component

Project architecture​

This SDK is leveraging Kotlin Multiplatform Mobile so most of the Models, Controllers, and Services (interactions with Miam API) can be implemented only once and reused both in iOS and Android apps. Only the Views have to be implemented separately for each platform.

Consequently, this SDK is organized in three main modules (TODO: naming to be reviewed):

  • /miamCore : contains the core logic shared between the two platforms
  • /androidSDK : the SDK to be built and imported in an Android app, containing the core logic + Android-related Views
  • /MiamIOSFramework : same thing, but for iOS apps

For instance, in the case of an Android application, you shouldn't have to import the built archive of /miamCore and /androidSDK : building /androidSDK to an APK and importing it will be enough, as this APK will contain the whole logic (/miamCore + Android views).