Pts: модульная библиотека для креативного кодирования
Pts — TypeScript/JavaScript-библиотека для визуализации точек в пространстве и творческого кодирования. Проект разрабатывается под лицензией Apache 2.0 и набрал на GitHub 4,3 тысячи звезд.
Библиотека написана на языке программирования TypeScript. Содержит алгоритмы для визуализации и творческого кодирования. API поддерживает как быстрое прототипирование, так и работу на крупных проектах.
Преимущества:
- Минимум кода для быстрых итераций в
canvas
,svg
и других форматах; - Функции для работы с геометрическими фигурами, цветами, моделированием и звуками;
- Может использоваться отдельно и совместно с другими библиотеками.
Использование
Шаг 1
Загрузите последнюю версию библиотеки pts.js
или pts.min.js
(находятся в папке dist). В качестве альтернативного способа используйте любую сеть доставки контента CDN, такую как, например, cdnjs, jsdelivr или unpkg. Затем добавьте загруженный файл библиотеки на html-страницу:
<script type="text/javascript" src="path/to/pts.js"></script>
#Вес мини-файла ~90КБ, сжатого — 26КБ.
Шаг 2
Выполните команду npm install pts
. Это позволяет импортировать нужные части библиотеки в проект.
<script type="text/javascript" src="path/to/pts.js"></script>
Чтобы начать работу, загрузите или клонируйте следующие репозитории:
- pts-starter-kit: пример приложения, с использованием
npm
иwebpack
; - pts-react-example: Pts с React;
- react-pts-canvas: расширение компонента
react-pts-canvas
в проекте React.
Для запуска ознакомьтесь с документацией. Демо-проекты можно посмотреть здесь. При возникновении проблемы обращайтесь в поддержку.
Для разработки
Сборка и тестирование
Клонируйте указанный репозиторий и установите зависимости через npm install
:
npm start npm run build npm test
Создание документации
Запустите указанный файл, чтобы сгенерировать документацию в формате Pts. (Требуется Python 3.6)
npm run docs
Для генерации типизированных документов, выполните следующую команду:
typedoc --readme none --out typedocs src --name Pts
Создайте файлы декларации и минимизации TypeScript:
npm run typings npm run minify
Сообщить об опечатке
Текст, который будет отправлен нашим редакторам: