Mendix Native

Mendix native mobile package for React Native applications.

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js: Version 18 (specified in .nvmrc)
• Yarn: Package manager (Yarn workspaces are required)
• React Native development environment (optional, only needed if running the example app): Follow the React Native environment setup guide
  • For iOS: Xcode and CocoaPods
  • For Android: Android Studio and Android SDK

Local Development Setup

This project is a monorepo managed using Yarn workspaces with:

• The library package in the root directory
• An example app in the example/ directory

1. Clone the Repository

git clone https://github.com/YogendraShelke/mendix-native.git
cd mendix-native

2. Enable Corepack and Install Dependencies

corepack enable
yarn install

This will enable Yarn via Corepack and install dependencies for both the library and the example app.

3. Build the Library

yarn prepare

This compiles the TypeScript code and generates the lib folder.

4. Run the Example App

The example app demonstrates library usage and reflects your local changes in real-time.

Start Metro Bundler

yarn example start

Run on iOS

yarn example ios

Or open in Xcode:

yarn dev:ios

Run on Android

yarn example android

5. Development Workflow

Making Changes

• JavaScript/TypeScript changes: Automatically reflected without rebuild
• Native code changes: Require rebuilding the example app

Edit Native Code

iOS (Objective-C/Swift):

• Open example/ios/MendixNativeExample.xcworkspace in Xcode
• Find source files at: Pods > Development Pods > mendix-native

Android (Java/Kotlin):

• Open example/android in Android Studio
• Find source files under: mendix-native in the Android view

Verify Your Code

Run type checking:

yarn typecheck

Run linter:

yarn lint

Fix linting issues:

yarn lint --fix

Run tests:

yarn test

6. Clean Build Artifacts

If you encounter build issues:

yarn clean

Available Scripts

• yarn install - Install dependencies
• yarn prepare - Build the library
• yarn typecheck - Type-check with TypeScript
• yarn lint - Lint code with ESLint
• yarn test - Run unit tests
• yarn clean - Remove build artifacts
• yarn example start - Start Metro bundler
• yarn example ios - Run example app on iOS
• yarn example android - Run example app on Android
• yarn dev:ios - Build, install pods, and open iOS project

Contributing

See CONTRIBUTING.md for detailed contribution guidelines.

---

Release Process

This repository supports automated releases using a GitHub Actions workflow. A manual fallback process is also documented below for situations where the workflow cannot be used.

Automated Release (Recommended)

The automated workflow handles:

• Bumping the package version
• Building and generating the lib folder
• Creating the tarball (.tgz)
• Creating a GitHub Release with attached artifact
• Moving the Unreleased notes from CHANGELOG.md into a new version section
• Creating a pull request against master with updated files

Steps

1. Go to GitHub → Actions → Manual Release.
2. Select Run workflow.
3. Choose the version bump type:
   • patch
   • minor
   • major
4. Run the workflow.

The workflow will:

• Update package.json version
• Run yarn install && yarn prepare to generate the build
• Run yarn pack to generate the .tgz file
• Create a new GitHub Release with:
  • tag = new version
  • release notes from the Unreleased section in CHANGELOG.md
  • the generated .tgz file attached
• Commit updated CHANGELOG.md and package.json
• Create a pull request:
  • branch: release/<version>
  • base: master

After the PR is merged, the release is complete.

Manual Release (Fallback)

If the automated workflow fails, the release can be performed manually with the same steps.

1. Bump the Version

Choose one:

npm version patch
npm version minor
npm version major

This updates package.json locally (you'll commit this later).

2. Install and Build

yarn install
yarn prepare

The prepare script should generate the lib folder.

3. Generate the Tarball

yarn pack

This creates a file like:

package-name-vX.Y.Z.tgz

Keep this file for the release.

4. Update CHANGELOG.md

Move the content under Unreleased into a new version heading.

Example:

## [Unreleased]

## [1.2.0] - 2025-01-15
<previous unreleased notes>

5. Commit Changes

git add CHANGELOG.md package.json
git commit -m "chore: release <version>"
git push

6. Create a GitHub Release Manually

1. Go to Releases → Draft a new release.
2. Use the version number as the tag and title.
3. Paste the notes you moved from the Unreleased section.
4. Upload the .tgz file from the yarn pack step.
5. Publish the release.

7. Create Pull Request (If Needed)

If your project requires PR-based updates, create a PR against master with the same changes you committed.

Summary

Use the automated workflow whenever possible because it handles every repetitive step. When needed, the fallback manual process mirrors the workflow exactly so releases remain consistent and predictable.