https://github.com/cartodb/carto-react

CARTO for React packages
https://github.com/cartodb/carto-react

carto deck-gl google-maps location-intelligence maps react

Last synced: 3 days ago
JSON representation

CARTO for React packages

• Host: GitHub
• URL: https://github.com/cartodb/carto-react
• Owner: CartoDB
• License: mit
• Created: 2020-11-18T18:28:52.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-11-29T14:29:24.000Z (about 2 months ago)
• Last Synced: 2025-01-11T13:43:49.335Z (10 days ago)
• Topics: carto, deck-gl, google-maps, location-intelligence, maps, react
• Language: JavaScript
• Homepage: https://docs.carto.com/react/
• Size: 8.97 MB
• Stars: 39
• Watchers: 19
• Forks: 16
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.MD

Awesome Lists containing this project

README

        
# CARTO React Library



  

    

  

  

    

  

  

    

  






This is the official "CARTO for React library". It is organized as a set of **npm packages** (`@carto/react-*`), that work together providing widgets and utilities to build Location Intelligence applications with React, Redux & Material-UI.

The packages are:

- [@carto/react-api](packages/react-api/README.md)

- [@carto/react-auth](packages/react-auth/README.md)

- [@carto/react-basemaps](packages/react-basemaps/README.md)

- [@carto/react-core](packages/react-core/README.md)

- [@carto/react-redux](packages/react-redux/README.md)

- [@carto/react-ui](packages/react-ui/README.md)

- [@carto/react-widgets](packages/react-widgets/README.md)

- [@carto/react-workers](packages/react-workers/README.md)

To work in the code, see [developers](DEVELOPERS.md).

These packages are used by the [CARTO for React templates](https://github.com/CartoDB/carto-react-template), made with CRA (Create React App).

There is a Storybook guide with the main UI components and how to use them at [CARTO for React - UI Components](https://storybook-react.carto.com/)

### How to install the library

If you are using the `CARTO CRA templates`, everything is already setup, so **no further configuration is needed!**

---

In case you want to use this set of packages in a different context, then you would need to install them as usual, with something like:

```

  yarn add @carto/react-api

  yarn add @carto/react-auth

  yarn add @carto/react-basemaps

  yarn add @carto/react-core

  yarn add @carto/react-redux

  yarn add @carto/react-ui

  yarn add @carto/react-widgets

  yarn add @carto/react-workers

```

Notice that to avoid issues within host projects, most of the base libraries are declared as **peer dependencies** (deck.gl, react, material-ui, reduxjs-toolkit, echarts...). That means that you would need to add them explicitly to your project, if you are still not using them (keep an eye on the console warnings on peer dependencies).