pts0.8.4 • Public • Published
Get started at ptsjs.org.
Pts is pretty lightweight. Currently at ~90kb minified and 26kb gzipped.
npm install pts. Then you can choose to import some parts of Pts into your project as needed.
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
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 startnpm run buildnpm test
Run this to generate Pts styled documentations. (Requires python 3.6)
npm run docs
If you prefer to generate default typedocs, run this:
typedoc --readme none --out typedocs src --name Pts
Generate typescript declaration files and minify
npm run typingsnpm run minify
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.
Apache License 2.0. See LICENSE file for details.
Copyright © 2017-2019 by William Ngan and contributors.