Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
66 lines (43 loc) · 1.41 KB

DEVELOPMENT.md

File metadata and controls

66 lines (43 loc) · 1.41 KB

Development Guide

shared-storage

The shared-storage module is a Kotlin Multiplatform (KMP) library that encapsulates the storage logic. It is used as the core backend for android and apple platforms.

Android

Android's shared-storage is distributed via maven local repo, which is then consumed by React Native module. To build the sdk, run:

yarn build:android

The artifact is then moved to packages/async-storage/android/local_repo for distribution.

Apple (iOS/macOS)

shared-storage for apple platforms is distributed as xcframework containing both Debug and Release binaries.

To build it:

yarn build:apple

The artifact is then moved to packages/async-storage/apple/Frameworks for distribution.

Documentation

Documentation should follow major.minor version of Async Storage. Update the documentation version in root's package.json:

{
  "versionDocs": "3.0"
}

Deployment

Add new remote where docs are hosted:

# use https if not using ssh
git remote add docs git@github.com:react-native-async-storage/react-native-async-storage.github.io.git

Fetch gh-pages branch:

git fetch docs gh-pages

Use python 3 to install dependencies:

pip install --no-deps -r .github/requirements.txt

Run mike deploy to deploy docs and mark them as latest:

mike deploy -u -r docs --push DOCS_VERSION_FROM_PCK_JSON latest