Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@MagdalenaKuch
MagdalenaKuch authored Oct 14, 2024
1 parent a9d10a8 commit cb94893
Showing 1 changed file with 26 additions and 26 deletions.
52 changes: 26 additions & 26 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,14 @@

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

The main branch's code shows a basic example of a map with a marker and navbar using React and MapTiler SDK. (MapTiler SDK extends MapLibre GL JS with functions related to the MapTiler mapping platform. The basic concepts of this tutorial also show how to create a react map with MapLibre GL JS)
Repository branches show code changes corresponding to the [MapTiler react video series]().
The main branch's code shows a basic example of a map with a marker and navbar using React and MapTiler SDK. (MapTiler SDK extends MapLibre GL JS with functions related to the MapTiler mapping platform. The basic concepts of this tutorial also show how to create a React map with MapLibre GL JS). You can find a step-by-step tutorial for it [here](https://docs.maptiler.com/react/sdk-js/get-started-material-ui/?utm_medium=social&utm_source=github&utm_campaign=2024%20|%20react).

Repository branches show code changes corresponding to the [MapTiler React video series](https://youtube.com/playlist?list=PLGHe6Moaz52Mb9_0qH9mdktsTgkrow9oI&si=2RCT0UU_2ssLyGjN).

**Get your MAPTILER_CLOUD_API_KEY** to make this code work: https://cloud.maptiler.com/account/keys/ You can create it for free!

You can learn more about [MapTiler SDK.](https://docs.maptiler.com/sdk-js/)
Find out more about [MapTiler Cloud](https://www.maptiler.com/cloud/) - where you can get your basemaps and store your mapping data.
You can learn more about [MapTiler SDK.](https://docs.maptiler.com/sdk-js/?utm_medium=social&utm_source=github&utm_campaign=2024%20|%20react)
Find out more about [MapTiler Cloud](https://www.maptiler.com/cloud/?utm_medium=social&utm_source=github&utm_campaign=2024%20|%20react) - where you can get your basemaps and store your mapping data.

![React map app done with MapTiler SDK](https://github.com/maptiler/maps-in-react/blob/main/assets/final_app.png)

Expand Down Expand Up @@ -46,35 +47,34 @@ Find out more about [MapTiler Cloud](https://www.maptiler.com/cloud/) - where yo

## Episode specific instructions

Here is the step-by-step guide for creating a state in the main branch: https://docs.maptiler.com/react/sdk-js/get-started-material-ui/. The only difference is that this repo has the Material UI for the navbar component, which is part of the map component.
Here is the step-by-step guide for creating a state in the main branch: https://docs.maptiler.com/react/sdk-js/get-started-material-ui/.

#### E1 - Map in react js with geojson data, points, and clusters
#### E1 - Map in React js with geojson data, points, and clusters

[step-by-step tutorial](https://docs.maptiler.com/react/react/sdk-js/geojson-points/)
[step-by-step tutorial](https://docs.maptiler.com/react/sdk-js/geojson-points/?utm_medium=social&utm_source=github&utm_campaign=2024%20|%20react)

add custom geojson data to a react map with SDK helpers
read more about MapTilerSDK point helpers: https://docs.maptiler.com/sdk-js/api/helpers/#point
add custom geojson data to a React map with SDK helpers
read more about **[MapTilerSDK point helper](https://docs.maptiler.com/sdk-js/api/helpers/#point?utm_medium=social&utm_source=github&utm_campaign=2024%20|%20react)**

You can find geojson data used in tutorial videos in the assets folder.
You can find GeoJSON data used in tutorial videos in the assets folder.

#### E2 - Map in React js with heatmap and visualization switcher

[step-by-step tutorial](https://docs.maptiler.com/react/)

MapTiler SDK heatmap helpers: https://docs.maptiler.com/sdk-js/api/helpers/#heatmap
[step-by-step tutorial](https://docs.maptiler.com/react/sdk-js/heatmap/?utm_medium=social&utm_source=github&utm_campaign=2024%20|%20react)

MapTiler SDK Color Ramp: https://docs.maptiler.com/sdk-js/api/color-ramp/
**[MapTiler SDK heatmap helper](https://docs.maptiler.com/sdk-js/api/helpers/#heatmap?utm_medium=social&utm_source=github&utm_campaign=2024%20|%20react)**
**[MapTiler SDK Color Ramp](https://docs.maptiler.com/sdk-js/api/color-ramp/?utm_medium=social&utm_source=github&utm_campaign=2024%20|%20react)**

#### E3 - Map in React js with popup and sidebar

[step-by-step tutorial](https://docs.maptiler.com/react/)
[step-by-step tutorial](https://docs.maptiler.com/react/sdk-js/popup-sidebar/?utm_medium=social&utm_source=github&utm_campaign=2024%20|%20react)

Material UI: https://mui.com/core/
MUI sidebar examples: https://mui.com/material-ui/react-drawer/
**Material UI:** https://mui.com/core/
**MUI sidebar examples:** https://mui.com/material-ui/react-drawer/

#### E4 - Map in React js with geocoding control

[step-by-step tutorial](https://docs.maptiler.com/react/)
[step-by-step tutorial](https://docs.maptiler.com/react/sdk-js/geocoding-control/?utm_medium=social&utm_source=github&utm_campaign=2024%20|%20react)

Download MapTiler geocoding control from npm: https://www.npmjs.com/package/@maptiler/geocoding-control

Expand All @@ -83,28 +83,28 @@ Open the terminal on the my-react-map folder.
- npm i @maptiler/geocoding-control
- npm install
- npm run dev //to start your map app
geocoding API reference https://docs.maptiler.com/client-js/geocoding/
[geocoding API reference](https://docs.maptiler.com/client-js/geocoding/?utm_medium=social&utm_source=github&utm_campaign=2024%20|%20react)

#### E5 - 3D Map in React js

[step-by-step tutorial](https://docs.maptiler.com/react/)
[step-by-step tutorial](https://docs.maptiler.com/react/sdk-js/3d-map/?utm_medium=social&utm_source=github&utm_campaign=2024%20|%20react)

Enable/disable map terrain programmatically: https://docs.maptiler.com/sdk-js/examples/map-terrain/
Enable/disable map terrain programmatically: [https://docs.maptiler.com/sdk-js/examples/map-terrain/](https://docs.maptiler.com/sdk-js/examples/map-terrain/?utm_medium=social&utm_source=github&utm_campaign=2024%20|%20react)

How to find id of last text map layer?
How to find the id of last text map layer?
![how to find layel id](https://github.com/maptiler/maps-in-react/blob/main/assets/layer_id.png)

1. Go to [MapTiler Cloud](https://cloud.maptiler.com/)
1. Go to [MapTiler Cloud](https://cloud.maptiler.com/?utm_medium=social&utm_source=github&utm_campaign=2024%20|%20react)
2. Select a map that you want to use as a basemap
3. Customize
4. Go to layer - Verticality and find the last symbol layer
5. Click at last symbol layer and open JSON editor ( {} )
5. Click at the last symbol layer and open JSON editor ( {} )
6. Copy layer id, e.g., "Ocean labels".

How to create a custom map style on MapTiler Cloud: https://documentation.maptiler.com/hc/en-us/articles/360020805917-How-to-make-custom-map-design-in-MapTiler-Cloud
How to create a custom map style on MapTiler Cloud: [https://documentation.maptiler.com/hc/en-us/articles/360020805917-How-to-make-custom-map-design-in-MapTiler-Cloud](https://documentation.maptiler.com/hc/en-us/articles/360020805917-how-to-make-custom-map-design-in-maptiler-cloud?utm_medium=social&utm_source=github&utm_campaign=2024%20|%20react)

## Build with

[Vite](https://vitejs.dev/guide/#scaffolding-your-first-vite-project)
[MapTiler SDK JS](https://docs.maptiler.com/sdk-js/)
[MapTiler SDK JS](https://docs.maptiler.com/sdk-js/?utm_medium=social&utm_source=github&utm_campaign=2024%20|%20react)
[MUI](https://mui.com/material-ui/)

0 comments on commit cb94893

Please sign in to comment.