Skip to content

SETUP.md

Latest commit

 

History

History
78 lines (51 loc) · 1.35 KB

SETUP.md

File metadata and controls

78 lines (51 loc) · 1.35 KB
Raw

Setup Guide for MapConductor React SDK

This guide explains how to set up the development environment for the MapConductor React SDK monorepo.

Prerequisites

  • Node.js >= 18.0.0
  • npm >= 9.0.0

Install Dependencies

This repository uses npm workspaces. Run installs from the repository root so local packages are linked automatically.

npm install

Build Packages

Build every workspace package that defines a build script:

npm run build

Development

Start package watch builds and the web example from the repository root:

npm run dev

Run only package watch builds:

npm run dev:packages

Run only the web example:

npm run dev:examples

The web example is available at http://localhost:3000.

Running the Example App Directly

cd examples/basic
npm run dev

Verification

npm run lint
npm run test

For React Native Android changes, run the Gradle compile task from the repository root when configured:

./gradlew :android:app:compileDebugKotlin

Troubleshooting

If dependency resolution looks stale, remove installed dependencies and reinstall:

npm run clean
npm install
npm run build

If TypeScript reports missing local packages, verify that dependencies were installed from the repository root, then rebuild the workspace packages.