https://github.com/cmudig/counterpoint

A Canvas Animation Library
https://github.com/cmudig/counterpoint

Last synced: 5 days ago
JSON representation

A Canvas Animation Library

• Host: GitHub
• URL: https://github.com/cmudig/counterpoint
• Owner: cmudig
• License: mit
• Created: 2023-10-27T21:59:46.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-08-04T22:16:15.000Z (3 months ago)
• Last Synced: 2024-08-04T22:18:59.395Z (3 months ago)
• Language: TypeScript
• Homepage: https://dig.cmu.edu/counterpoint/
• Size: 5.35 MB
• Stars: 6
• Watchers: 1
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Counterpoint: Canvas Animation Library

This is a library to help people develop beautiful large-scale animated data visualizations using HTML5 Canvas and WebGL. [See the docs >](https://dig.cmu.edu/counterpoint)

## Installation and Usage

Install Counterpoint from NPM:

```bash

npm install --save counterpoint-vis

```

You can use a static ESM version of the library in vanilla JS like so:

```javascript

import { Mark, MarkRenderGroup } from 'https://cdn.jsdelivr.net/npm/counterpoint-vis@latest/dist/counterpoint-vis.es.js';

```

## Dev Installation

Clone the repository, then from within the repo directory run:

```bash

cd counterpoint

npm install

npm run dev

```

This watches the library contents and rebuilds automatically to the `counterpoint/dist` directory.

You can run the examples by going into their respective directories, running `npm install`, then `npm run dev`.

## Documentation Build

If not installed, install [Ruby and Jekyll](https://jekyllrb.com/docs/installation/). Then `cd` into the `docs` directory and run:

```bash

bundle install

bundle exec jekyll serve

```