README
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-2 (basic template for CARTO 2)
@carto/cra-template-sample-app-2 (sample app template for CARTO 2)
@carto/cra-template-sample-app-3 (sample app template for CARTO 3)
@carto/cra-template-base-3-typescript (basic template for CARTO 3 with TypeScript)
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, just type:
npx create-react-app my-app --template @carto/cra-template-base-3
cd my-app
yarn start
Note: that's the version corresponding to CARTO 3 (latest, recommended), but there is also another template for CARTO 2 (@carto/cra-template-base-2)
A full Sample Application with the most common functionality 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.