README.md

PLEASE NOTE THAT THIS REPOSITORY IS OUT OF DATE AND NO LONGER MAINTAINED.

WE CREATED A NEW VERSION OF OPENMAPPR THAT DOES NOT REQUIRE HOSTING ON A COMPUTE SERVER

THAT 'STATIC' PLAYER IS MAINTAINED HERE https://github.com/vibrant-data-labs/openmappr-player

YOU DON'T NEED TO CLONE THAT - WHICH IS THE INTERFACE "CONTAINER."

INSTEAD YOU PUBLISH MAPS DIRECTLY FROM PYTHON USING "PY2MAPPR":

https://github.com/vibrant-data-labs/py2mappr

OpenMappr 📊

Documentation 📄

Development

Windows is not officially supported at this time.

• Prerequisites Install Guide for macOS
• Prerequisites Install Guide for Ubuntu
• Prerequisites Install Guide for Fedora
• How to validate prerequisites are installed

Deployment

• How to connect to an OpenMappr server
• How to deploy a production server
• How to use a local or remote Mongo host
• How to integrate Sendgrid for feedback

Starting local development 👨‍💻

First you need to install the following prerequisites. The installation instructions may vary based on your operating system. Please review the prerequisite install guides listed above.

• Git
• Docker & Docker Compose
• Node.js 8.12.0 (nvm is recommended)
• NPM along with the yo, bower, and grunt-cli packages
• Ruby along with the sass and compass gems

Then you will want to download or clone the project, and open up a terminal inside the project folder.

git clone https://github.com/vibrant-data-labs/openmappr.git
cd openmappr

After doing so, run the following commands to install all the dependencies:

npm install
bower install

To build the client and perform JS ops, run:

grunt

Next you will want to run the following command to bring up the local docker compose stack:

docker-compose -f docker-compose.local.yml up -d

After it finishes, you can start the server with:

./run_local_mode.sh

And navigate to localhost:8080 with your web browser.

Exiting local development 💤

To shut down the development server, press ctrl+c to exit, and then run docker-compose down to shut down the docker stack.