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…

What is this?An open-source exercise illustration library with 302 exercises and 906 transparent SVG frames (three per exercise), shipped as a typed, framework-neutral npm package (@bryllim/workout-guide) plus a searchable static gallery site for browsing them.
Is this a library or a full app?It's a monorepo containing an npm library package (packages/workout-guide) with the typed API, manifest, and SVG/PNG assets, plus an Astro-built static site (apps/site) that serves as the public gallery and docs.
How do I add it to my project?Install the @bryllim/workout-guide npm package and then either import the SVG assets directly or use the literal React Native require() pattern shown in the integration guide.
Do I need to regenerate the image catalog myself?No — the normalized catalog and all package assets are already checked into the repo; regenerating from a source export with npm run catalog:import is only needed by maintainers updating the data.
Does it work with React Native and Expo, or just web?It's framework-neutral, so it works in plain web/React projects as well as React Native and Expo apps, matching the require()-based import examples in the guide.
Are the exercise images free to use however I want?Code and docs are MIT licensed, but the illustrations themselves are CC BY-SA 4.0 (derived from Everkinetic poses), so you must follow share-alike attribution rules when using the artwork.
Why does each exercise have three frames?The three consistent frames per exercise let you show the stages of a movement or build a simple animation from static SVGs instead of a single still pose.
What is Everkinetic?Everkinetic is the original CC BY-SA 4.0 exercise-pose illustration project that this library's artwork is based on; Bryl Lim expanded it with more exercises, frames, and structured metadata.
What image formats are included?Mainly 512x512 transparent SVGs (906 total, three per exercise), with the original PNG sources also kept in the package for compatibility.
Can I browse the exercises without installing the package?Yes, there's a searchable static gallery site built with Astro where you can browse all 302 exercises and their illustrations before integrating anything.
Creator
bryllim
Size
38.9 MB
Stars
1.4K
Age
1mo
Commits · 90 Days