⚠️ ARCHIVED - This repository is no longer maintained

This repository has been archived and is no longer actively maintained.

This project was last updated on 2024-01-09 and is preserved for historical reference only.

• 🔒 Read-only: No new issues, pull requests, or changes will be accepted
• 📦 No support: This code is provided as-is with no support or updates
• 🔍 For reference only: You may fork this repository if you wish to continue development

For current CARTO projects and actively maintained repositories, please visit: https://github.com/CartoDB

---

CARTO for React

Welcome to CARTO for React! The best way to develop Location Intelligence (LI) Apps using CARTO platform + React + deck.gl.

You can see for yourself how easy it is to create an application in this video.

It is based on the most popular toolchain, Create React App, and it will allow you to start with a well designed structure following the best practices for modern frontend development and an integrated toolchain for testing, building and deploying your application.

@carto/cra-template-base-3 (basic template for CARTO 3)

@carto/cra-template-base-3-typescript (basic template for CARTO 3 with TypeScript)

@carto/cra-template-sample-app-3 (sample app template for CARTO 3)

Getting started

The basic prerequisite for using Create React App is to have a package manager (npm or yarn) previously installed. yarn is preferred for developers contributing to the projects, as it will ensure a better integration with external libs.

To download our basic template for create-react-app and kickstart your application, just type the following command:

npm:

npx create-react-app my-app --template @carto/base-3

Yarn:

yarn create react-app my-app --template @carto/base-3

Note: that's the version corresponding to CARTO 3 (latest, recommended), but there are also other templates mentioned above.

Then you can start the development server:

npm:

cd my-app
npm start

Yarn:

cd my-app
yarn start

A full Sample Application with the most common functionality, deployed from the sample-app-3 template, is available at https://sample-app-react.carto.com

---

Want to know more about it? Visit the CARTO for React documentation page for more details, guides and a reference.