Arute Map Library

Arute Map Library is a lightweight, developer-friendly solution built with Deck.gl and React. It provides essential tools for creating dynamic and interactive maps with ease.

Key Features

• Full integration with Deck.gl for advanced data visualizations.
• Support for modular and extensible designs to fit various project needs.
• React compatibility for seamless integration into web applications.

Installation

Install the library using Yarn:

yarn add arute-map-gl

Usage

Here is a basic example of how to use the Arute Map Library in your project:

import React from 'react';
import { Map } from 'arute-map-gl';

const App = () => {
  return (
    /* Add your map component here */
  );
};

export default App;

Documentation

Visit the official documentation to learn more about how to use the library:

Arute Map Library Documentation

Development

Prerequisites

Ensure you have the following tools installed:

• Node.js (>=18.x)
• Yarn (>=1.22.x)

Install Dependencies

yarn install

Build the Project

yarn build

Run Storybook

To develop components with Storybook:

yarn storybook

Build Storybook

To generate a static Storybook build:

yarn build-storybook

Scripts

• build: Compiles the TypeScript source code into JavaScript.
• storybook: Starts the Storybook development server.
• build-storybook: Builds a static Storybook site.
• test: Runs the tests (placeholder).

Project Structure

├── src          # Source code
├── dist         # Compiled output
├── stories      # Storybook stories
├── README.md    # Documentation
├── package.json # Project configuration

Peer Dependencies

Ensure the following peer dependencies are installed in your project:

• react (>=18.0.0)
• react-dom (>=18.0.0)

License

This project is licensed under the MIT License. See the LICENSE file for details.

Author

Arute Solutions 2024