jsanz / ems-landing-page

Previewer for the data of the Elastic Maps Service

Home Page:https://maps.elastic.co

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Elastic Maps Service Landing Page

The Elastic Maps Landing Page is a previewer of the data of the Elastic Maps Service. It allows users to browse the data that is available within EMS.

Development

The page is designed as a single-page application. It loads the root manifest from EMS using a cross-domain call. This is similar to how Kibana retrieves the manifest from EMS.

Please carefully review the CONTRIBUTING.md document before submitting any pull requests.

Prerequisites

yarn is used as the dependency manager and script runner for this project. Ensure both node and yarn are installed on your system.

webpack is used for Javascript transpilation.

To use the recommended node version for running the dev and compile tasks, you can use

nvm use

Running the page locally

Install dependencies

yarn install

Start the babel compilation and watch task

yarn dev

Keep this running. The javascript/css will be automatically recompiled when files change.

Open the page

Open public/index.html

You can run the page either from the file-system or any web-server.

Packaging

To package the app, run the build script.

yarn build

This script will put the relevant resources of the app in the ./build/release/** folder.

If any intermediate tasks break before packaging, such as a javascript linting or compilation failure, the build-script will error out. Fix the errors, and redeploy.

Continuous Integration and Deployment

  • When a PR is merged Jenkins will run deployStaging.sh script, which will place code into the staging bucket.
  • Deploying to production requires manually triggering this Jenkins job to run the deployProduction.sh script. This will rsync files in all branches to the production bucket. To trigger, log in and click the "Build with Parameters" link.

About

Previewer for the data of the Elastic Maps Service

https://maps.elastic.co

License:Other


Languages

Language:JavaScript 71.4%Language:Shell 18.9%Language:Python 7.2%Language:CSS 2.0%Language:Handlebars 0.4%