Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Lokhy87/gymApp/llms.txt

Use this file to discover all available pages before exploring further.

The exercise library is the starting point for every workout in GymFlow. From the home screen you select a muscle group, which opens a filtered list of exercises belonging to that group. Each exercise is shown as a card with its name and a representative image. Tapping a card opens a quick-log modal so you can record sets, reps, weight, and notes without leaving the page.

​
How to browse exercises

1

Open the home screen

After logging in you land on the Muscle Groups screen. The page calls GET /api/muscle_groups and renders one card per group.
2

Select a muscle group

Click any group card. The app navigates to /exercises?group={id}, fetches all exercises, and filters the results client-side to show only those whose muscle_group_id matches the selected group.
3

Browse exercise cards

Each card shows the exercise name and its image. Scroll through the list to find the movement you want to perform.
4

Log a set from the exercise card

Click any exercise card to open the quick-log modal. Fill in weight, reps, sets, and an optional note, then click Save workout to save the entry. The modal defaults to 3 sets, 10 reps, and 0 kg so you only need to change what differs.

​
What each exercise shows

FieldDescription
idUnique numeric identifier for the exercise
nameDisplay name shown on the card and in the modal header
imageURL of the exercise illustration or photo
muscle_group_idID of the parent muscle group; used for filtering

​
API reference

​
List all muscle groups

curl https://api.gymflow.example/api/muscle_groups \
  -H "Authorization: Bearer <token>"

[
  { "id": 1, "name": "Chest", "image": "https://..." },
  { "id": 2, "name": "Back",  "image": "https://..." },
  { "id": 3, "name": "Legs",  "image": "https://..." }
]

​
List exercises

curl https://api.gymflow.example/api/exercises \
  -H "Authorization: Bearer <token>"

[
  { "id": 12, "name": "Bench Press",     "image": "https://...", "muscle_group_id": 1 },
  { "id": 13, "name": "Incline Dumbbell","image": "https://...", "muscle_group_id": 1 },
  { "id": 24, "name": "Squat",           "image": "https://...", "muscle_group_id": 3 }
]
To retrieve only the exercises that belong to a specific group, pass the muscle_group_id query parameter:
curl "https://api.gymflow.example/api/exercises?muscle_group_id=1" \
  -H "Authorization: Bearer <token>"
The server returns only the exercises whose muscle_group_id matches the value you provide. The Angular frontend fetches all exercises and filters them locally, but calling the endpoint with this parameter reduces the payload size.

Log a workout

Learn how to save, edit, and delete individual workout entries.

View your history

See every workout you have logged in a monthly calendar view.

Exercises API

Full endpoint reference for the exercises and muscle-groups resources.

Track progress

Visualize how your weight-lifted has changed over time for any exercise.

Build docs developers (and LLMs) love

Get started for freeTalk to us