platform docs

Get Started. It's Free
or sign up with your email address
platform docs by Mind Map: platform docs

1. backend platform docs

1.1. myFlow Device

1.2. Data Base

1.2.1. Athletes

1.2.1.1. Training

1.2.1.1.1. Block

2. admin view

2.1. Coaches progress

3. Managing seats & licenses

3.1. Where are goggles and how many goggles are assigned to plan (MindMetrix admin)

3.2. Report issues with goggles

3.3. (tbd) See current licenses and additional plans (BASIC - PRO - FULL)

3.3.1. Depending on plan additional features are listed then for all athletes.

3.3.2. Buy/Upgrade plan (license) and buy additional goggles

4. nextjs platform

4.1. API

4.1.1. auth

4.1.1.1. POST

4.1.1.1.1. sign-up

4.1.1.1.2. sign-in

4.1.2. /devices

4.1.2.1. GET

4.1.2.1.1. limit

4.1.2.1.2. page

4.1.2.1.3. (sort and filters)

4.1.2.2. POST/PATCH

4.1.2.2.1. name

4.1.2.2.2. location

4.1.2.2.3. users[]

4.1.2.3. DELETE

4.1.2.3.1. /{id} (device)

4.1.3. /users

4.1.3.1. GET

4.1.3.1.1. limit

4.1.3.1.2. page

4.1.3.1.3. (sort and filters)

4.1.3.2. POST/PATCH

4.1.3.2.1. name

4.1.3.2.2. email

4.1.3.2.3. password

4.1.3.2.4. role

4.1.3.2.5. coach

4.1.3.2.6. subscription

4.1.3.3. DELETE

4.1.3.3.1. /{id} (user)

4.1.4. /athletes (users for coach)

4.1.4.1. GET

4.1.4.1.1. limit

4.1.4.1.2. page

4.1.4.1.3. (sort and filters)

4.1.4.1.4. /{id} (user)

4.1.5. /coaches (users for athletes)

4.1.5.1. GET

4.1.5.1.1. limit

4.1.5.1.2. page

4.1.5.1.3. (sort and filters)

4.1.5.1.4. /{id} (user)

4.1.6. /plans

4.1.6.1. POST/PATCH

4.1.6.1.1. name

4.1.6.1.2. schedule[]

4.1.6.1.3. author

4.1.6.2. DELETE

4.1.6.2.1. /{id} (plan)

4.1.7. /trainings

4.1.7.1. POST/PATCH

4.1.7.1.1. name

4.1.7.1.2. blocks [id]

4.1.7.1.3. author

4.1.7.2. DELETE

4.1.7.2.1. /{id} (training)

4.1.8. /blocks

4.1.8.1. POST/PATCH

4.1.8.1.1. name

4.1.8.1.2. trials [id]

4.1.8.2. DELETE

4.1.8.2.1. /{id} (block)

4.1.9. /trials

4.1.9.1. POST/PATCH

4.1.9.1.1. name

4.1.9.2. DELETE

4.1.9.2.1. /{id} (trial)

4.2. Sign In Page

4.2.1. Sign In Form

4.2.1.1. email

4.2.1.2. password

4.3. Sign Up Page

4.3.1. Sign Up Form

4.3.1.1. name

4.3.1.2. email

4.3.1.3. password

4.3.1.4. confirmPassword

4.4. Dashboard

4.4.1. Header

4.4.1.1. User information

4.4.1.1.1. Avatar

4.4.1.1.2. Dropdown menu

4.4.1.2. Notifications bell

4.4.1.2.1. Notifications popover

4.4.2. Sidebar

4.4.2.1. common view

4.4.2.1.1. Home Page (depends on role)

4.4.2.1.2. Learn

4.4.2.1.3. Schedule

4.4.2.1.4. FAQ

4.4.2.2. admin view

4.4.2.2.1. Coaches (Home Page)

4.4.2.2.2. Devices Management

4.4.2.2.3. Users Management

4.4.2.2.4. Trainings Management

4.4.2.2.5. Blocks Management

4.4.2.2.6. Trials Management

4.4.2.2.7. Training Plans Management

4.4.2.3. coach view

4.4.2.3.1. Athletes (Home Page)

4.4.2.3.2. Trainings Management (only own trainings)

4.4.2.3.3. Training Plans Management (only own plans)

4.4.2.3.4. Compare

4.4.2.4. athlete view

4.4.2.4.1. myStats (Home Page)

4.4.2.4.2. Compare

4.4.3. Home Page

4.4.3.1. admin view

4.4.3.1.1. Coaches progress

4.4.3.2. coach view

4.4.3.2.1. Team progress

4.4.3.3. athlete view

4.4.3.3.1. Trainings progress cards

4.4.3.3.2. VR Device Status card

4.4.3.3.3. Coach information card

4.4.4. User Profile

4.4.4.1. common view

4.4.4.1.1. User Info

4.4.4.1.2. User Stats

4.4.5. Schedule

4.4.5.1. Schedule Calendar

4.4.5.1.1. common view

4.4.5.1.2. coach view

4.4.6. Training Plans Page

4.4.6.1. Training Plans Table

4.4.6.1.1. Sorting

4.4.6.1.2. Filtering

4.4.6.1.3. Searching

4.4.6.1.4. Create/Edit

4.4.6.1.5. Delete

4.4.7. Trainings Page

4.4.7.1. Trainings List

4.4.7.1.1. Training Card

4.4.7.2. Trainings Table

4.4.7.2.1. Sorting

4.4.7.2.2. Filtering

4.4.7.2.3. Searching

4.4.7.2.4. Create/Edit

4.4.7.2.5. Delete

4.4.8. Blocks Page

4.4.8.1. Blocks Table

4.4.8.1.1. Sorting

4.4.8.1.2. Filtering

4.4.8.1.3. Searching

4.4.8.1.4. Create/Edit

4.4.8.1.5. Delete

4.4.9. Trials Page

4.4.9.1. Trials Table

4.4.9.1.1. Sorting

4.4.9.1.2. Filtering

4.4.9.1.3. Searching

4.4.9.1.4. Create/Edit

4.4.9.1.5. Delete

4.4.10. Users Page

4.4.10.1. Users Table

4.4.10.1.1. Sorting

4.4.10.1.2. Filtering

4.4.10.1.3. Searching

4.4.10.1.4. Create/Edit

4.4.10.1.5. Delete

4.4.11. Devices Page

4.4.11.1. Devices Table

4.4.11.1.1. Sorting

4.4.11.1.2. Filtering

4.4.11.1.3. Searching

4.4.11.1.4. Create/Edit

4.4.11.1.5. Delete

5. FAQ

6. Dashboard

6.1. Summary performance charts

6.1.1. How many of scheduled trainings have been performed?

6.1.2. Streak for scheduled trainings

6.1.3. Progress within training plan (percentage training plan completed)

6.1.4. How many additional trainings added

6.2. Detailed performance charts

6.2.1. Only performance metrics displaying training averages

6.2.2. Performance metrics to display

6.2.2.1. Success rate

6.2.3. For each performance metrics and time, filtering data by (this metadata has to be adaptable)

6.2.3.1. Training Type - implemented in a way, that additional trainings could be added in the future

6.2.3.1.1. Up

6.2.3.1.2. Down

6.2.3.2. Used strategies during training (metadata information) - more strategies to be defined

6.2.3.2.1. Breathing

6.2.3.2.2. Mental – Physical

6.2.3.2.3. Mental - Emotional

6.2.3.2.4. Mental – Nothing state

6.2.3.3. Time of Day of training

6.2.3.3.1. Morning

6.2.3.3.2. Evening

6.3. Data should be downloadable (.csv / .xls) (coach)

6.3.1. Team overview (summary metrics)

6.3.2. Athlete overview (more details)

7. Dashboard

7.1. Summary Page

7.2. Users Page

8. Registration

8.1. Collect and save information for future role assignment by admin

9. Login

10. Roles

10.1. Admin

10.1.1. Add coaches

10.1.2. Add athletes

10.1.3. Full data access

10.2. Coach

10.2.1. See their athletes data

10.2.2. Assign athlete to predefined training plan

10.2.3. Add/Edit/Delete single trainings for athletes

10.2.4. Has training schedule of all their athletes visualized (not necessarily a calendar)

10.2.5. Overview of which athletes adhered to trainings so far

10.3. Athlete

10.3.1. See only their own data

10.3.2. See trainings schedule (not necessarily a calendar)

10.3.3. Notifications

10.4. Psychologist

10.4.1. No description