workout-guide README

The project's README from github.com/bryllim/workout-guide. As one markdown file: README.md.

Workout Guide

An open exercise illustration library containing 302 exercises, three consistent frames per exercise, a typed framework-neutral npm package, and a searchable static gallery.

The original pose artwork used by this project comes from Everkinetic under CC BY-SA 4.0. Bryl Lim expanded upon that foundation with additional exercises and animation frames, normalized assets, structured metadata, package APIs, and the documentation gallery.

Browse the gallery · Read the guide · Open the package on npm

Install

npm install @bryllim/workout-guide
import { getExercise, searchExercises, getAssetUrl } from '@bryllim/workout-guide';

const pushUp = getExercise('push-up');
const bodyweightChest = searchExercises('chest', { equipment: 'bodyweight' });
const firstFrame = getAssetUrl('push-up', 1);

Direct asset imports and literal React Native require() examples are documented in the integration guide.

Repository

This npm-workspace monorepo contains:

Run the project locally:

npm install
npm run check
npm run dev

The normalized catalog and all package assets are checked into the repository. Maintainers can regenerate them from a compatible source export with npm run catalog:import -- /path/to/source.

Licensing

Code and documentation are available under the MIT License. Visual assets are licensed under CC BY-SA 4.0. See LICENSES.md and ATTRIBUTION.md for the complete breakdown, including Everkinetic-derived poses.

Contributions are welcome. Please read CONTRIBUTING.md and the Code of Conduct.

workout-guide (bryllim/workout-guide)

Searching Database…

这是什么?一个开源健身动作插画库,包含 302 个动作和 906 张透明 SVG 帧(每个动作三张),以类型化、框架无关的 npm 包(@bryllim/workout-guide)形式发布,另有一个可搜索的静态画廊网站供浏览。
这是一个库还是完整的应用?它是一个 monorepo,包含提供类型化 API、清单和 SVG/PNG 资源的 npm 库包(packages/workout-guide),以及一个用 Astro 构建的静态站点(apps/site),充当公开画廊和文档。
怎么把它加到我的项目里?安装 @bryllim/workout-guide npm 包,然后直接导入 SVG 资源,或使用集成指南中展示的原样 React Native require() 模式。
我需要自己重新生成图片目录吗?不需要——规范化后的目录和所有包资源都已提交到仓库;只有维护者更新数据时,才需要用 npm run catalog:import 从源导出重新生成。
它支持 React Native 和 Expo 吗,还是只支持网页?它框架无关,因此在普通网页/React 项目以及 React Native 和 Expo 应用中都能使用,与指南中基于 require() 的导入示例一致。
这些动作插画可以随意免费使用吗?代码和文档采用 MIT 许可,但插画本身是 CC BY-SA 4.0(源自 Everkinetic 的姿势图),所以使用这些美术素材时必须遵守相同方式共享的署名规则。
为什么每个动作有三帧?每个动作的三张一致帧让你能展示动作的各个阶段,或用静态 SVG 搭建简单动画,而不只是单一静止姿势。
Everkinetic 是什么?Everkinetic 是这个库的美术素材所基于的原始 CC BY-SA 4.0 健身姿势插画项目;Bryl Lim 在其基础上扩充了更多动作、帧和结构化元数据。
包含哪些图片格式?主要是 512x512 的透明 SVG(共 906 张,每个动作三张),包里还保留了原始 PNG 源文件以供兼容。
不安装这个包也能浏览这些动作吗?可以。有一个用 Astro 构建的可搜索静态画廊网站,在集成之前你就可以浏览全部 302 个动作及其插画。
Creator
bryllim
Size
38.9 MB
Stars
1.4K
Age
1mo
Commits · 90 Days