https://github.com/cartodb/toolkit

JS library to interact with CARTO APIs in a simple way
https://github.com/cartodb/toolkit

Last synced: 6 days ago
JSON representation

JS library to interact with CARTO APIs in a simple way

• Host: GitHub
• URL: https://github.com/cartodb/toolkit
• Owner: CartoDB
• License: bsd-3-clause
• Created: 2019-09-18T15:58:18.000Z (about 5 years ago)
• Default Branch: web-sdk
• Last Pushed: 2023-01-05T06:08:22.000Z (almost 2 years ago)
• Last Synced: 2024-04-09T20:58:26.758Z (7 months ago)
• Language: TypeScript
• Homepage: https://toolkit-wheat.now.sh
• Size: 3.61 MB
• Stars: 9
• Watchers: 7
• Forks: 3
• Open Issues: 27
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# CARTO Toolkit - New Web-SDK!

This is a monorepo intended to contain all small-medium sized JS libraries that are used to create CARTO Apps. Currently contains:

- An auth library, mainly for OAuth.

- A SQL API library.

- A Custom Visualizations library.

- A Viz library, built on top of deck.gl

- A Metapackage that exposes all

It uses [Lerna](https://lerna.js.org) to manage all the packages and inter-dependencies.

Quick steps to check that build works correctly

```sh

 nvm use

 npm install

 npm run build

```

## Development

### Linking Deck.gl

In order to work with your local version of Deck.gl in this project, you need to link the Deck.gl module or modules (take into account Deck.gl is a lerna project too, so it is a bunch of different projects) you need into this one.

- In the root of deck.gl project

```

yarn build

```

- Move to the module you want to link (in this example we want to link @deck.gl/layers)

```

cd modules/layers/

npm link

```

- In the root of the toolkit project

```

npm link @deck.gl/layers

```