MapLibre GL JS map using React JS

Quick way to star a web map application with MapLibre GL JS using Create React App.

A simple fullscreen map application as an example on how to use MapTiler maps together with React and MapLibre GL JS for your own React app.

The map application contains a title component, a map component with navigation controls, and a marker.

---

📖 Documentation   🌐 Website   🔑 Get API Key

---

Table of Contents

• Basic Usage
• Examples
• Support
• Contributing
• License
• Acknowledgements

🚀 Basic Usage

Create an app

To create a new react project run in your command-line:

npx create-react-app my-react-map --template @maptiler/cra-template-maplibre-gl-js

Navigate to the newly created project folder my-react-map

cd my-react-map

API KEY

Rename or copy the .env.example file to .env

cp .env.example .env

Open the .env file, ⚠️ you will need to replace YOUR_MAPTILER_API_KEY with your own MapTiler API key.

Your MapTiler account access key is on your MapTiler Cloud account page.

ℹ️ If you don't have an API KEY you can create it for free at https://www.maptiler.com/cloud/

Run

To start your local environment run:

npm start

You will find your app on address http://localhost:3000/.

Now you should see the app in your browser.

Build

To build for production, run:

npm run build

gh-pages

To deploy the app to the gh-pages branch, run:

npm run deploy

💡 Related Examples

• How to display MapLibre GL JS map using React JS
• Get Started with React JS and MapLibre GL JS
• MapLibre GL JS geocoding control how to search places using React JS

Check out the full list of MapTiler examples

💬 Support

• 📚 Documentation - Comprehensive guides and API reference
• ✉️ Contact us - Get in touch or submit a request
• 🐦 Twitter/X - Follow us for updates

---

🤝 Contributing

We love contributions from the community! Whether it's bug reports, feature requests, or pull requests, all contributions are welcome:

• Fork the repository and create your branch from main
• If you've added code, add tests that cover your changes
• Ensure your code follows our style guidelines
• Give your pull request a clear, descriptive summary
• Open a Pull Request with a comprehensive description

📄 License

This project is licensed under the MIT License – see the LICENSE file for details.

🙏 Acknowledgements

This project is built on the shoulders of giants:

• MapTiler – Maps for developers
• MapLibre GL JS – Open-source TypeScript library for publishing maps on your website
• React.js – The library for web and native user interfaces

Get Your API Key ^FREE
Start building with 100,000 free map loads per month ・ No credit card required.

💜 Made with love by the MapTiler team

Website • Documentation • GitHub