Globo Map UI

This is the UI part of the Globo Map project that consists of mapping any structure in the form of a graph.

Installing / Getting started

To run the UI, first you need a Globo Map API endpoint running. See Globo Map API.

# Set API environment variable
export GLOBOMAP_API_URL=<api_endpoint>/v2
export GLOBOMAP_API_USERNAME=<username>
export GLOBOMAP_API_PASSWORD=<password>

# Install dependencies, build a deployable version, run
npm install
npm run build
node server

Now you have an up and running Globo Map UI app (http://localhost:8888)

Developing

Built With

• React + Redux
• Express
• Axios

Prerequisites

Globo Map API

Setting up Dev

Globo Map UI was built with Create React App. To run the Dev environment:

git clone https://github.com/globocom/globomap-ui
cd globomap-ui
npm install

# You still need to set a environment variable with Globo Map API endpoint url:
export GLOBOMAP_API_URL=<api_endpoint>/v2

# Start server
node server

# On another terminal, run the app in dev mode
npm start

Building

When code changes, you need to run the build script:

npm run build

This will create an optmized version of the app with performance improvements.

Running local with docker:

make dynamic_ports
make containers_build (When project not started yet.)
make containers_start (When project not started yet.)

Licensing

Globo Map UI is under Apache 2 License