Skip to main content

Quick Start Guide

Prerequisites​

Before getting started, make sure you have the following installed on your system:

  • Node.js (version 18.0 or higher)
  • npm or yarn package manager
  • Expo CLI (for React Native development)
💡 Pro Tip

You can check your Node.js version by running node --version in your terminal.

Step 1: Create a New Expo Application​

First, let's create a fresh Expo application as the foundation for your Mapples project.

npx create-expo-app@latest my-mapples-app
cd my-mapples-app
📝 Note

If you already have an existing Expo application, you can skip this step and navigate to your project directory.

Step 2: Initialize Mapples in Your Project​

Now, let's add Mapples to your project using the Mapples CLI. This will set up all the necessary configurations and dependencies.

⚠️ API Key Required

Before running the initialization command, you need to obtain a Mapples API key. Visit Mapples Creator to get your API key and set up your account. For detailed instructions, see our API Key Guide.

npx @mapples/cli init

This command will:

  • Install Mapples dependencies and required expo packages
  • Configure your project structure
  • Download the Mapples assets, pages and sync styles
  • Generate initial configuration files
🎉 Success!

Once the initialization is complete, you'll have a fully configured Mapples project ready for development.

Step 3: Start Development​

Launch your development environment to start building with Mapples on your target platform:

npx expo run:ios
📝 Platform Requirements
  • iOS: Requires Xcode and iOS Simulator (macOS only)
  • Android: Requires Android Studio and Android SDK
  • Web: Works on any platform with a modern browser

For more detailed information about Expo development workflows, visit the Expo Documentation.

What's Next?​

🎯 Congratulations! You now have a working Mapples application. Here's what you can explore next:

🔧 App Integration

Learn how to integrate Mapples into your existing React Native app or configure a new project.

Integration Guide →

🎨 Mapples Creator

Learn how to use the visual creator tools to design your application interface.

Explore Creator →

📦 Packages

Discover available Mapples packages to extend your application functionality.

Browse Packages →