React-based project skeleton for a map application by Geoapify

• The project was created with Create React App.
• The project uses Sass3 - .scss CSS pre-processor.

STEP 1. Run the application

1. Clone or download the source code of the application to your computer.
2. Install Node.js if not installed from Download page or via package manager.
3. Go to the application directory.
4. Run npm install.
5. Run npm start.
6. Open http://localhost:3000 to view it in the browser. The page will be reloaded automatically when you make changes to the project.

The page contains only one phrase "The map will be displayed here", that we replace now with a map.

Geoapify Map Tiles

Geoapify offers vector and raster map tiles of different styles and colors.

We use Mapbox style specification that defines the visual appearance of a map: what data to draw, the order to draw it in, and how to style the data when drawing it.

Visit our documentation page for Map Tiles to get a map style link for a map.

Geoapify API key

You will require Geoapify API Key to display a map. Register and get an API key for free on Geoapify MyProjects.

We have a Freemium pricing model. Start using our services now for FREE and extend when you need.

Text editor

You can use any text editor for writing HTML, CSS, and JavaScript. However, we recommend you try Visual Studio Code.

STEP 2 - Option 1. Display a map with MapLibre GL(open-source fork of Mapbox GL)

---

In December 2020 the Mapbox GL JS version 2.0 was released under a proprietary license. So Mapbox GL 2.x not under the 3-Clause BSD license anymore. The MapLibre GL is the official open-source fork of Mapbox GL.

---

1. Go to the application directory.
2. Run npm i maplibre-gl to install Mapbox GL library.
3. Add Mapbox GL styles to the index.scss:

@import '~maplibre-gl/dist/maplibre-gl.css';

4. Add the code to the src/components/my-map.jsx:

import React, { useEffect } from 'react'; 
import './my-map.scss';
import maplibre from 'maplibre-gl';

const MyMap = ({mapIsReadyCallback /* To be triggered when a map object is created */ }) => {
  let mapContainer;

  useEffect(() => {
    const myAPIKey = 'YOUR_API_KEY_HERE'; 
    const mapStyle = 'https://maps.geoapify.com/v1/styles/osm-carto/style.json';

    const initialState = {
      lng: 11,
      lat: 49,
      zoom: 4
    };

    const map = new maplibre.Map({
      container: mapContainer,
      style: `${mapStyle}?apiKey=${myAPIKey}`,
      center: [initialState.lng, initialState.lat],
      zoom: initialState.zoom
      });

    mapIsReadyCallback(map);

  }, [mapContainer]);

  return (
    <div className="map-container" ref={el => mapContainer = el}>
    </div>
  )
}

export default MyMap;

5. Replace YOUR_API_KEY_HERE with an API key you've got on Geoapify MyProjects.
6. Set the mapStyle variable to Map style you want to use.

STEP 2 - Option 2. Display a map with Leaflet

---

The Leaflet library doesn't have native support for vector map tiles. There a number of Leaflet plugins that may help o visualize vector maps. However, none of them is actively supported.

This tutorial contains instructions on how to visualize raster map tiles. Note, that you need in different vector maps you need to take care of high-resolution screens. Use the '@2x' suffix to get high-resolution map tile images.

---

1. Go to the application directory.
2. Run npm i leaflet to install Leaflet library.
3. Add Leaflet and Mapbox GL styles to the index.scss:

@import '~leaflet/dist/leaflet.css';

4. Add the code to the src/components/my-map.jsx:

import React, { useEffect } from 'react';
import './my-map.scss';
import L from 'leaflet';

const MyMap = ({mapIsReadyCallback /* To be triggered when a map object is created */ }) => {
  let mapContainer;

  useEffect(() => {
    const initialState = {
      lng: 11,
      lat: 49,
      zoom: 4
    };

    const map = L.map(mapContainer).setView([initialState.lat, initialState.lng], initialState.zoom);

    var myAPIKey = 'YOUR_API_KEY_HERE';

    var isRetina = L.Browser.retina;
    var baseUrl = "https://maps.geoapify.com/v1/tile/osm-bright/{z}/{x}/{y}.png?apiKey={apiKey}";
    var retinaUrl = "https://maps.geoapify.com/v1/tile/osm-bright/{z}/{x}/{y}@2x.png?apiKey={apiKey}";
    
    L.tileLayer(isRetina ? retinaUrl : baseUrl, {
      attribution: 'Powered by <a href="https://www.geoapify.com/" target="_blank">Geoapify</a> | <a href="https://openmaptiles.org/" rel="nofollow" target="_blank">© OpenMapTiles</a> <a href="https://www.openstreetmap.org/copyright" rel="nofollow" target="_blank">© OpenStreetMap</a> contributors',
      apiKey: myAPIKey,
      maxZoom: 20,
      id: 'osm-bright',
    }).addTo(map);

    mapIsReadyCallback(map);

  }, [mapContainer]);

  return (
    <div className="map-container" ref={el => mapContainer = el}>
    </div>
  )
}

export default MyMap;

5. Replace YOUR_API_KEY_HERE with an API key you've got on Geoapify MyProjects.
6. Set the mapStyle variable to Map style you want to use.

STEP 2 - Option 3. Display a map with OpenLayers

1. Go to the application directory.
2. Run npm install ol ol-mapbox-style to install OpenLayers library and Mapbox map style support.
3. Add OpenLayers styles to the index.scss:

@import '~ol/ol.css';

4. Add the code to the src/components/my-map.jsx:

import React, { useEffect } from 'react';
import './my-map.scss';
import olms from 'ol-mapbox-style';
import * as proj from 'ol/proj';

const MyMap = ({mapIsReadyCallback /* To be triggered when a map object is created */ }) => {
  let mapContainer;

  useEffect(() => {
    const initialState = {
      lng: 11,
      lat: 49,
      zoom: 4
    };

    const myAPIKey = 'YOUR_API_KEY_HERE';
    const mapStyle = 'https://maps.geoapify.com/v1/styles/osm-carto/style.json';

    olms(mapContainer, `${mapStyle}?apiKey=${myAPIKey}`).then((map) => {
      map.getView().setCenter(proj.transform([initialState.lng, initialState.lat], 'EPSG:4326', 'EPSG:3857'));
      map.getView().setZoom(initialState.zoom);

      mapIsReadyCallback(map);
    });

  }, [mapContainer]);

  return (
    <div className="map-container" ref={el => mapContainer = el}>
    </div>
  )
}

export default MyMap;

5. Replace YOUR_API_KEY_HERE with an API key you've got on Geoapify MyProjects.
6. Set the mapStyle variable to Map style you want to use.

Build the application

Run npm run build from the application directory.
This builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance. The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

More options

You can learn about more build options in the Create React App documentation.