Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/CartoDB/carto-vl
CARTO VL: a Javascript library to create vector-based visualizations
https://github.com/CartoDB/carto-vl
Last synced: about 2 months ago
JSON representation
CARTO VL: a Javascript library to create vector-based visualizations
- Host: GitHub
- URL: https://github.com/CartoDB/carto-vl
- Owner: CartoDB
- License: bsd-3-clause
- Created: 2017-10-13T12:56:39.000Z (almost 7 years ago)
- Default Branch: develop
- Last Pushed: 2022-12-09T13:27:31.000Z (almost 2 years ago)
- Last Synced: 2024-07-20T21:41:03.414Z (2 months ago)
- Language: JavaScript
- Homepage:
- Size: 60.5 MB
- Stars: 129
- Watchers: 36
- Forks: 26
- Open Issues: 148
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY_POLYCY.md
Awesome Lists containing this project
README
# **CARTO VL**
[](https://circleci.com/gh/CartoDB/carto-vl)
**CARTO VL** is an open source JavaScript library for developers to create vector-based visualizations inside Location Intelligence applications.
## Features
- Maps are rendered client-side, instead of being rendered on the server. As a result, we provide faster load times and overall app performance by eliminating potential server problems.
- Built-in smart point aggregations and geometry simplifications making it easier than ever to visualize and interact with larger datasets. CARTO VL does this in a dynamic and automatic way, meaning you don’t need to rerun costly and time-expensive pre-processing steps over the geometry.
- Ability to modify geometries directly in the browser. This is a powerful solution for animated visualizations of points, lines, and polygons.
- Full control over everything happening on the map and can provide rich reactions to user interactions.
- New and intuitive map styling language that is designed specifically for multi-scale, thematic cartography. With just a few lines, complex visualizations can be created. Non-programmers can create their first map easily, while programmers will still be able to exploit the full potential of the CARTO ecosystem.
## Example
Run this
```
width: 8
color: ramp(buckets($dn, [80, 100, 140]), prism)
strokeWidth: 0
filter: $dn > 60
```
To see
## I want to make a map
To start, you will need a basic HTML file structure to display your map in a browser. We recommend you to follow this [Getting started](https://carto.com/developers/carto-vl/guides/getting-started/) guide to create a basic map. Then, you can get familiarized with the rest of the library following this link: https://carto.com/developers/carto-vl/guides/introduction/, which includes a list with more specific and advanced guides.
Also, take a look at our [examples](https://carto.com/developers/carto-vl/examples/) to understand the possibilities and inspire you!
An alternative way, if you already have a build system in your project (*webpack*, *rollup*...), is to use our [npm package](https://www.npmjs.com/package/@carto/carto-vl). You can install it with:
```
npm i @carto/carto-vl
```
Take a look at an example made with webpack [here](https://github.com/CartoDB/carto-vl-webpack-demo).
Happy mapping!
## I want to contribute to CARTO VL
That's great! We are more than happy to receive your contributions to the code and its documentation.
### Install
To clone and run this library, you'll need [Git](https://git-scm.com) and [Node.js](https://nodejs.org/en/download/) (which comes with [npm](http://npmjs.com)) installed on your computer. From your command line:
```bash
# Clone this repository
$ git clone https://github.com/CartoDB/carto-vl
# Go into the repository
$ cd carto-vl
# Install dependencies (node >=6.11.5 is required)
$ yarn
# Bundle the library
$ yarn build
```
For more information, please read [DEVELOPERS.md](https://github.com/CartoDB/carto-vl/blob/master/DEVELOPERS.md).
### Start developing
Get started using CARTO VL's documentation at [CARTO's Developer Center](https://carto.com/developers/carto-vl/).
- [Guides](https://carto.com/developers/carto-vl/guides/): get to know the library as a user!
- [Full reference API](https://carto.com/developers/carto-vl/reference/): for specific methods, arguments, and sample code.
### Play with the examples
You can find all the [examples](https://carto.com/developers/carto-vl/examples/) on the documentation in the `examples` folder. There are also some developer focused examples on the `debug` folder.
Run the following commands to access them locally:
```bash
# Bundle the library with a watch dog
$ yarn build:watch
# Run a server
$ yarn serve
```
### Contributing
Lastly, check out [CONTRIBUTING.md](https://github.com/CartoDB/carto-vl/blob/master/CONTRIBUTING.md) for more information about submitting pull requests to us. You will need to sign a Contributor License Agreement (CLA) before making a submission. [Learn more here.](https://carto.com/contributions/)
## Feedback
We encourage you to start playing with CARTO VL and to please [send us feedback](https://github.com/CartoDB/carto-vl/issues) so we can create an even better library, suited to your needs.
## Works with
CARTO VL is a geo-spatial data visualization library. However it doesn't include basemap rendering capabilities. Therefore, CARTO VL needs to be used with [Mapbox GL](https://github.com/mapbox/mapbox-gl-js) as a basemap provider. You'll need to use Mapbox GL (>=v.0.50.0) for controlling the center and zoom level of your map too. The integration is seamless, check the examples!
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/CartoDB/carto-vl/tags).
## Authors
- [David Manzanares](https://github.com/davidmanzanares)
- [Jesús Arroyo Torrens](https://github.com/Jesus89)
- [Iago Lastra](https://github.com/IagoLast)
- [Javier Goizueta](https://github.com/jgoizueta)
- [Elena Torro](https://github.com/elenatorro)
- [Raúl Ochoa](https://github.com/rochoa)
- [Mamata Akella](https://github.com/makella)
- [Víctor Velarde](https://github.com/VictorVelarde)
- [Ariana Escobar](https://github.com/arianaescobar)
- [Jesús Botella](https://github.com/jesusbotella)
## License
This project is licensed under the BSD 3-clause "New" or "Revised" License - see the [LICENSE](LICENSE) file for details.
## BrowserStack
[BrowserStack](https://www.browserstack.com/) supports this OpenSource project, providing us with valuable tools to test CARTO VL over different systems and browsers configurations.
