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…

1.4K ·GitHub
Workout-guide
Что это?Open-source библиотека иллюстраций упражнений: 302 упражнения и 906 прозрачных SVG-кадров (по три на упражнение), поставляется в виде типизированного npm-пакета, не привязанного к фреймворку (@bryllim/workout-guide), плюс сайт со статической галереей с поиском для их просмотра.
Это библиотека или полноценное приложение?Это монорепозиторий: в нём лежит npm-пакет-библиотека (packages/workout-guide) с типизированным API, манифестом и ассетами SVG/PNG, а также статический сайт на Astro (apps/site), который служит публичной галереей и документацией.
Как добавить его в свой проект?Установите npm-пакет @bryllim/workout-guide, затем либо импортируйте SVG-ассеты напрямую, либо используйте показанный в руководстве по интеграции паттерн require() для React Native.
Нужно ли самому перегенерировать каталог изображений?Нет — нормализованный каталог и все ассеты пакета уже лежат в репозитории; перегенерация из исходного экспорта через npm run catalog:import нужна только мейнтейнерам, обновляющим данные.
Работает ли это с React Native и Expo, или только для веба?Библиотека не привязана к фреймворку, поэтому работает в обычных веб/React-проектах, а также в приложениях React Native и Expo — как в примерах импорта на основе require() из руководства.
Можно ли использовать изображения упражнений как угодно?Код и документация — под лицензией MIT, но сами иллюстрации распространяются по CC BY-SA 4.0 (на основе поз из Everkinetic), поэтому при использовании графики нужно соблюдать правила атрибуции и share-alike.
Почему у каждого упражнения три кадра?Три согласованных кадра на упражнение позволяют показать фазы движения или собрать простую анимацию из статичных SVG, а не ограничиваться одной статичной позой.
Что такое Everkinetic?Everkinetic — исходный проект иллюстраций поз для упражнений под CC BY-SA 4.0, на котором основана графика этой библиотеки; Bryl Lim расширил его новыми упражнениями, кадрами и структурированными метаданными.
Какие форматы изображений входят в состав?В основном прозрачные SVG 512x512 (всего 906, по три на упражнение); в пакете для совместимости сохранены и исходные PNG.
Можно ли посмотреть упражнения, не устанавливая пакет?Да, есть статический сайт-галерея на Astro с поиском, где можно просмотреть все 302 упражнения и их иллюстрации до какой-либо интеграции.
What are similar projects?blobatar, expo, ng-native, victory, agent-device, react-native-elements, NativeBase, react-native-calendars
Which topics is it in?fitness, gallery, assets, expo, astro, static-site-generator, npm-package, react-native, svg, monorepo, mobile, ios
Creator
bryllim
Size
38.9 MB
Stars
1.4K
Updated
CommitAug 26Releasev1.0.0Aug 24
Age
1mo
Commits · 90 Days