\n
![](\"https://dqplcvw3fzili.cloudfront.net/rampkitlogo.png\")
\n\n
\n \n
Build, test, and improve your onboarding experience with instant updates.
\n\n---\n\n## What is RampKit?\n\nRampKit lets you create, edit, and deploy onboarding flows from the web. No new releases. No code changes. You design your onboarding in the RampKit dashboard and the Expo SDK handles the rest.\n\n---\n\n## Features\n\n- Visual web builder\n- A/B testing\n- Personalized onboardings\n- Instant updates\n- Analytics and insights\n\n---\n\n## Installation\n\n```sh\nnpx expo install rampkit-expo-dev\n```\n\n---\n\n## Setup\n\n```ts\nimport { RampKit } from \"rampkit-expo-dev\";\n\nawait RampKit.configure({\n appId: \"YOUR_APP_ID\",\n environment: \"production\", // optional\n autoShowOnboarding: false, // optional\n appUserID: \"your-user-123\", // optional - your own user ID for analytics linking\n onOnboardingFinished: (payload) => {\n // optional callback fired when the flow finishes\n },\n});\n```\n\nShow an onboarding:\n\n```ts\nRampKit.showOnboarding();\n```\n\n---\n\n## Configuration Options\n\n```ts\nawait RampKit.configure({\n appId: \"YOUR_APP_ID\",\n environment: \"staging\", // optional\n autoShowOnboarding: true, // optional (auto-present after configure if data is available)\n appUserID: \"user-123\", // optional - link with your own user database\n onOnboardingFinished: (payload) => {\n // optional\n },\n});\n\n// Access the generated stable user id (stored securely)\nconst idFromInit = RampKit.getUserId(); // string | null (available after configure)\n\n// Or fetch/generate it directly (always returns a string)\nimport { getRampKitUserId } from \"rampkit-expo-dev\";\nconst userId = await getRampKitUserId();\n\n// Get stored onboarding responses\nconst responses = await RampKit.getOnboardingResponses();\n```\n\n---\n\n## Custom App User ID\n\nYou can associate your own user identifier with RampKit analytics. This is useful for linking RampKit data with your own user database.\n\n**Important:** This is an alias only - RampKit still generates and uses its own internal user ID (`appUserId`) for tracking. Your custom `appUserID` is stored alongside it for your reference.\n\n### Set at Configuration\n\n```ts\nawait RampKit.configure({\n appId: \"YOUR_APP_ID\",\n appUserID: \"your-user-123\", // Set during configuration\n});\n```\n\n### Set After Configuration\n\n```ts\n// Set or update the app user ID at any time\nawait RampKit.setAppUserID(\"your-user-123\");\n\n// Get the current app user ID\nconst customId = RampKit.getAppUserID(); // string | null\n```\n\n---\n\n## Accessing Onboarding Responses\n\nRampKit automatically stores user responses when questions are answered during onboarding. You can retrieve these responses at any time:\n\n```ts\nconst responses = await RampKit.getOnboardingResponses();\n\nfor (const response of responses) {\n console.log(\"Question:\", response.questionId);\n console.log(\"Answer:\", response.answer);\n console.log(\"Answered at:\", response.answeredAt);\n}\n```\n\nEach `OnboardingResponse` contains:\n\n| Property | Type | Description |\n|----------|------|-------------|\n| `questionId` | `string` | Unique identifier for the question |\n| `answer` | `any` | The user's answer (any JSON-serializable value) |\n| `questionText` | `string?` | Optional question text shown to user |\n| `screenName` | `string?` | Screen where question was answered |\n| `answeredAt` | `string` | ISO 8601 timestamp |\n\nResponses are automatically cleared when `reset()` is called.\n\nMore examples are in the docs: \nhttps://rampkit.com/docs\n\n---\n\n## Example\n\n```ts\nimport { useEffect } from \"react\";\nimport { RampKit } from \"rampkit-expo-dev\";\nimport { Button } from \"react-native\";\n\nexport default function App() {\n useEffect(() => {\n // Configure once in your app\n RampKit.configure({ appId: \"YOUR_APP_ID\" });\n }, []);\n\n return (\n