Giter VIP home page Giter VIP logo

globomap-ui's Introduction

GloboMap logo

build status

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

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.