README.md

GeoPortal v5

Mecklenburg County's main GIS portal for the public, built with Svelte, TailwindCSS, and Maplibre GL JS. The development and build environment is Vite. GeoPortal is designed for speed (perfect Lighthouse scores), ease of use, and works well on mobile devices.

Site: https://mcmap.org/geoportal

Architecture

GeoPortal is a single page application (SPA) and progressive web app (PWA). It consumes a number of services to operate, as outlined in the architecture image.

Two optional environmental variables control the map layers, VITE_MAPTILES for the URL for base map tile style and VITE_AERIALS for aerials URL. The easiest way to set these variables is by creating a .env file in the root project folder:

VITE_MAPTILES="https://style-url.json"
VITE_AERIALS="https://aerials/{z}/{x}/{y}"

If the VITE_AERIALS environmental variable is not supplied, the aerial toggle button will not appear on the map. If the VITE_MAPTILES environmental variable is not supplied, no map toggle option will be available.

Using the project

Node.js is required to run the development and build systems, and git is required to use the versioning system.

Clone the project

git clone https://github.com/tobinbradley/Mecklenburg-County-GeoPortal.git geoportal

Install dependencies

cd geoportal
npm install

Start the development server

npm run dev

Navigate a web browser to http://localhost:3000 to view the HMR live development server.

Build for production

npm run build

After the build is complete, copy the contents of the dist folder to the production web server.