Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/azure/react-azure-maps-playground


https://github.com/azure/react-azure-maps-playground

azure azure-maps azure-maps-control microsoft react

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README

        

# React Azure Maps Playground

The **React Azure Map Playground** utilize [Storybook](https://storybook.js.org/) to provide an interactive way to explore and experiment with the [**react-azure-maps**](https://github.com/Azure/react-azure-maps) components.

Visit React Azure Map Playground: https://azure.github.io/react-azure-maps-playground/

## Usage

In the playground, you can:

- Learn how to effectively integrate Azure Maps into your React projects
- Adjust the component settings via the controls provided.
- Observe the immediate effects of your changes on the map.
- Read the full source code of the examples.

## Running Locally

Before you begin, ensure you have met the following requirements:

- **Node.js**: Make sure you have Node.js installed on your machine. This project uses Node.js v20.16.0.
- **npm**: npm is required for package management. It comes with Node.js, so you should have it by default.

### Installation

Follow these steps to get your local environment up and running:

1. **Clone the Repository**

```bash
git clone https://github.com/Azure/react-azure-maps-playground.git
```

2. **Navigate to the Project Directory**

```bash
cd react-azure-maps-playground
```

3. **Install Dependencies**

Use npm to install the necessary packages:

```bash
npm install
```

### Running the Project

Once the dependencies are installed, you can run the project locally.

Start the Storybook server to view and interact with the components:

```bash
npm run storybook
```

Open your web browser and navigate to [http://localhost:6006](http://localhost:6006) to view the Storybook interface.