JavaScript CSS HTML
Latest commit 4a2b089 Feb 11, 2017 @siddharthlatest siddharthlatest committed on GitHub Update README.md

README.md

Reactive Maps

A React components library for building maps that update in realtime.

Join the chat at https://gitter.im/appbaseio/reactivemaps Build Status Image

TOC

  1. Reactive Maps: Intro
  2. Features
  3. Component Playground
  4. Live Examples
  5. Installation
  6. Getting Started
  7. Docs Manual
  8. Developing Locally


1. Reactive Maps: Intro

Reactivemaps is a React based components library for building realtime maps. It is built on top of the appbase.io realtime DB service and ships with 20+ components for Lists, Dropdowns, Numeric Range, Sliders, Data Search, Places Search, Distance Slider and Dropdowns, Calendars, Feeds and Maps.

The library is conceptually divided into two parts:

  1. Sensor components and
  2. Actuator components.

Each sensor component is purpose built for applying a specific filter on the data. For example:

  • A SingleList sensor component applies an exact match filter based on the selected item.
  • A RangeSlider component applies a numeric range query based on hte values selected from the UI.

On or more sensor components can be configured to create a combined query context to render the results via an actuator.

ReactiveMaps comes with two actuators: ReactiveMap and ResultList. The former displays the filtered data from individual sensor components on a map interface while the latter displays the filtered data on a simple list interface.

2. Features

Design

  • The sensor / actuator design pattern allows creating complex UIs where any number of sensors can be chained together to reactively update an actuator (or even multiple actuators).
  • The library handles the transformation of the UI interactions into database queries. You only need to include the components and associate each with a DB field.
  • Built in live updates - Actuators can be set to update results even when the underlying data changes in the DB.
  • Comes with a cleanly namespaced styles API that allows extending the existing component styles without hassle.
  • Built in light and dark UI themes.

Ease of Use

  • Can be installed with NPM,
  • Can be run in browser without including any NPM or bundlers (gulp, webpack, etc.), see a demo here,
  • Works out of the box with Materialize CSS and comes with a polyfill CSS for Bootstrap. Compatibility for other frameworks can be added too.

3. Component Playground

Try the live component playground at playground. Look out for the knobs section in the playground part of the stories to tweak each prop and see the udpates.

4. Live Examples

A set of examples inspired by real world apps built with the ReactiveMaps library.

You can check all of them on the examples page.

5. Installation

Follow the installation guide from the official docs here.

You can try out the library live without any installation via the interactive tutorial.

6. Getting Started

Follow the getting started guide to build a Hello Maps! app from the official docs here.

7. Docs Manual

The official docs for the library are at https://opensource.appbase.io/manual.

The components are divided into two sections:

TODO - Add docs for the mapping section between UI components and DB backend.

8. Developing Locally

git clone https://github.com/appbasieo/reactivemaps
npm install

Start the development server on port 8012.

npm start

Examples can be accessed at https://localhost:8012/examples.

You can also start the component playground on port 9009 with

npm run storybook

By adding the manual submodule, you can access the docs locally.

git submodule init
cd manual && git submodule update

Once added, the docs manual can be accessed at http://localhost:8012/manual.