Skip to content

A basic project set up to get started with Mappedin JS quickly

Notifications You must be signed in to change notification settings

MappedIn/mappedin-js-quickstart

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Mappedin JS Quickstart

A minimal template project demonstrating how to display an interactive 3D indoor map using Mappedin JS v6.

This project accompanies the Mappedin JS Getting Started Guide.

Features

  • Interactive 3D indoor map rendering
  • Pan, zoom, and rotate controls
  • Built with Vite and TypeScript

Prerequisites

Getting Started

1. Clone the Repository

git clone https://github.com/MappedIn/mappedin-js-quickstart.git
cd mappedin-js-quickstart

2. Install Dependencies

yarn install

Or with npm:

npm install

3. Run the Development Server

yarn dev

Or with npm:

npm run dev

Open your browser and navigate to the URL shown in the terminal (typically http://localhost:5173).

Project Structure

mappedin-js-quickstart/
├── index.html          # HTML entry point with map container
├── src/
│   └── main.ts         # Main TypeScript file that initializes the map
├── package.json        # Project dependencies and scripts
└── tsconfig.json       # TypeScript configuration

Demo API Keys

This project uses Mappedin demo API keys for demonstration purposes. These keys are subject to the Demo Keys and Maps Terms and Conditions.

To use Mappedin JS with your own venue, you'll need a Pro license. Visit the Mappedin Pricing page for more information.

Available Scripts

Script Description
yarn dev Start the development server
yarn build Build for production
yarn preview Preview the production build

Resources

About

A basic project set up to get started with Mappedin JS quickly

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •