DEVELOPMENT.md
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'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.
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 should follow major.minor version of Async Storage. Update the documentation version in root's package.json:
{
"versionDocs": "3.0"
}
Add new remote where docs are hosted:
# use https if not using ssh
git remote add docs [email protected]: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