MVW Installation

This section describes the installation steps for the Mukau CMS component as a standalone. It also describes the steps inorder to push any changes made to the Mukau CMS.

This contains mapviewer, side-by-side maps and other embedable map components utilized within the Mukau Wagtail CMS built with ReactJS

Requirements

Native execution requires the following:

• Nodejs
• yarn

There are included Dockerfile and docker compose configuration files that may make it easier to run the application locally.

Installation

Clone the repository

git clone https://github.com/icpac-igad/mukau-viz-components.git

Be sure you are using the correct Nodejs version. We recommend using NVM to handle different Node versions.

Begin by installing the necessary nodejs packages, using yarn:

yarn

You also need to specify the necessary environment variables - check the corresponding section for more details.

To start the application in development mode, use the built-in development web server:

yarn dev # runs the development server

The application will be served in http://localhost:3000/.

Production build

Running the application in a production environment is a two-step process:

• Preprocessing the existing code and generating pre-renders of each page
• Launch a web server to serve said pages

This can be achieved using the following commands:

yarn build
yarn start

Environment variables

Before running the project for first time, be it for development, testing or production, you need to specify the correct values for key environment variables (env vars) used by the project.

TODO: Inlcude Setup Instructions on Mukau Wagtail CMS