Pts

A library for visualization and creative-coding

Canvas Drawing

williamngan/pts ptsjs.org pts

README

Pts

Pts is a typescript/javascript library for visualization and creative-coding.

Get started at ptsjs.org.

Please give it a try, file issues, and send feedbacks to @williamngan. Thank you!

Usage

Option 1

Get the latest pts.js or pts.min.js (in dist folder). Alternatively use a CDN service like cdnjs or jsdelivr or unpkg. Then add it to your html page like this:

``` html
<script type="text/javascript" src="path/to/pts.js"></script>
```

Pts is pretty lightweight. Currently at ~90kb minified and 26kb gzipped.

Option 2:

Install via npm install pts. Then you can choose to import some parts of Pts into your project as needed.

``` js
import {CanvasSpace, Pt, Group, Line} from 'pts';
```

To quickly get started, try download or clone these repos:

- pts-starter-kit: Get started with a sample app using npm and webpack

- pts-react-example: Try an example of using Pts with React.

- react-pts-canvas: Use it in your React project by extending react-pts-canvas component

Get Started

Read the guides and take a look at the demos and their source code.

If you need help, please don't hesitate to file an issue.

For development

Pts is written in typescript. You can clone or fork this project and build it as follows:

Build and test

Clone this repo and install dependencies via npm install.

``` sh
npm start
npm run build
npm test
```

Generate documentations

Run this to generate Pts styled documentations. (Requires python 3.6)

``` sh
npm run docs
```

If you prefer to generate default typedocs, run this:

``` sh
typedoc --readme none --out typedocs src --name Pts
```

Generate typescript declaration files and minify

``` sh
npm run typings
npm run minify
```

Contributing

We appreciate your support and feedbacks!

Please file issues if you find bugs and have feature requests. If you are able to send small PRs to improve Pts or fix bugs, that would be awesome too.

For larger PRs, please ping @williamngan to discuss first.

License

Apache License 2.0. See LICENSE file for details.

Pts