Copy all your gpx files to GPX_OUT or new gpx files

python run_page/gpx_sync.py

Copy all your tcx files to TCX_OUT or new tcx files

python run_page/tcx_sync.py

Copy all your tcx files to FIT_OUT or new fit files

python run_page/fit_sync.py

• If you only want to sync type running add args --only-run
• If you only want tcx files add args --tcx
• If you only want fit files add args --fit
• If you are using Garmin as a data source, it is recommended that you pull the code to your local environment to run and obtain the Garmin secret. The Python version must be >=3.8

Get Garmin Secret

Enter the following command in the terminal

# to get secret_string
python run_page/get_garmin_secret.py ${your email} ${your password}

Execute Garmin Sync Script

Copy the Secret output in the terminal,If you are using GitHub, please configure GARMIN_SECRET_STRING in GitHub Action.

# use this secret_string
python run_page/garmin_sync.py ${secret_string}

example：

python run_page/get_garmin_secret.py xxxxxxxxxxx

only-run：

python run_page/garmin_sync.py xxxxxxxxxxxxxx(secret_string) --only-run

• If you only want to sync type running add args --only-run
• If you only want tcx files add args --tcx
• If you only want fit files add args --fit
• If you are using Garmin as a data source, it is recommended that you pull the code to your local environment to run and obtain the Garmin secret. The Python version must be >=3.10

Get Garmin CN Secret

Enter the following command in the terminal

# to get secret_string
python run_page/get_garmin_secret.py ${your email} ${your password} --is-cn

Execute Garmin CN Sync Script

Copy the Secret output in the terminal,If you are using GitHub, please configure GARMIN_SECRET_STRING_CN in GitHub Action.

example：

python run_page/garmin_sync.py xxxxxxxxx(secret_string) --is-cn

only-run：

python run_page/garmin_sync.py xxxxxxxxxxxxxx(secret_string)  --is-cn --only-run

• If you only want to sync type running add args --only-run The Python version must be >=3.10

Get Garmin CN Secret

Enter the following command in the terminal

# to get secret_string
python run_page/get_garmin_secret.py ${your email} ${your password} --is-cn

Get Garmin Secret

Enter the following command in the terminal

# to get secret_string
python run_page/get_garmin_secret.py ${your email} ${your password}

Sync Garmin CN to Garmin

Enter the following command in the terminal

# to sync garmin-cn to garmin-global
python run_page/garmin_sync_cn_global.py ${garmin_cn_secret_string} ${garmin_secret_string}

Please note:Due to the discontinuation of Nike Run Club in mainland China, you can only log in through a VPN. Before starting, please ensure that you are using a global non-mainland China proxy, allowing you to access nike.com instead of nike.com.cn, as shown in the following image.

1. Sign in/Sign up NikeRunClub account

2. after successful login,openF12->Application->localstorage-> copy the content of "access_token" from the value of keyhttps://www.nike.com.

3. Execute in the root directory , you should be able to see the image below, and then you can log into your account on the mobile as usual:

   python run_page/nike_sync.py ${access_token}

   

   if you want to automate the submission of NRC data, you can refer to issue692.

   If you've previously synced activities and want to continue syncing new ones, with --continue-sync args

   python run_page/nike_sync.py ${access_token} --continue-sync

Please note: When you choose to deploy running_page on your own server, due to Nike has blocked some IDC's IP band, maybe your server cannot sync Nike Run Club's data correctly and display 403 error, then you have to change another way to host it.

Get Nike's refresh_token

ALL need to do outside GFW.

1. Login from this website, open F12 -> XHR -> get the refresh_token from login api.

2. copy this refresh_token and use it in GitHub Secrets or in command line

3. Execute in the root directory:

python run_page/nike_sync.py ${nike refresh_token}

example：

python run_page/nike_sync.py eyJhbGciThiMTItNGIw******

[!NOTE] Strava updated its Developer Program in June 2026. If you use Strava as the data source, or upload activities to Strava before syncing, check your app tier in the Strava API settings dashboard. Standard Tier developers need a Strava subscription to access the API; existing Standard Tier developers are affected from June 30, 2026. See Strava's announcement for details.

1. Sign in/Sign up Strava account

2. Open after successful Signin Strava Developers -> Create & Manage Your App

3. Create My API Application: Enter the following information

   
   

   

   Created successfully:

   
   

   

4. Use the link below to request all permissions: Replace ${your_id} in the link with My API Application Client ID

   https://www.strava.com/oauth/authorize?client_id=${your_id}&response_type=code&redirect_uri=http://localhost/exchange_token&approval_prompt=force&scope=read_all,profile:read_all,activity:read_all,profile:write,activity:write
   

   Example:

   https://www.strava.com/oauth/authorize?client_id=115321&response_type=code&redirect_uri=http://localhost/exchange_token&approval_prompt=force&scope=read_all,profile:read_all,activity:read_all,profile:write,activity:write
   

   

5. Get the code value in the link

   
   

   example：

   http://localhost/exchange_token?state=&code=1dab37edd9970971fb502c9efdd087f4f3471e6e&scope=read,activity:write,activity:read_all,profile:write,profile:read_all,read_all

   code value：

   1dab37edd9970971fb502c9efdd087f4f3471e6

   

6. Use Client_id、Client_secret、Code get refresh_token: Execute in Terminal/iTerm

   curl -X POST https://www.strava.com/oauth/token \
   -F client_id=${Your Client ID} \
   -F client_secret=${Your Client Secret} \
   -F code=${Your Code} \
   -F grant_type=authorization_code

   example：

   curl -X POST https://www.strava.com/oauth/token \
   -F client_id=12345 \
   -F client_secret=b21******d0bfb377998ed1ac3b0 \
   -F code=d09******b58abface48003 \
   -F grant_type=authorization_code

   

7. Sync Strava data

   The first time you synchronize Strava data you need to change line 12 of the code False to True in strava_sync.py, and then change it to False after it finishes running. If you only want to sync type running add args --only-run

   python run_page/strava_sync.py ${client_id} ${client_secret} ${refresh_token}

   References：

   • https://developers.strava.com/docs/getting-started
   • https://github.com/barrald/strava-uploader
   • https://github.com/strava/go.strava

1. follow the strava steps

2. copy all your tcx files to TCX_OUT

3. Execute in the root directory:

   python run_page/tcx_to_strava_sync.py ${client_id} ${client_secret}  ${strava_refresh_token}

   example：

   python run_page/tcx_to_strava_sync.py xxx xxx xxx
   or
   python run_page/tcx_to_strava_sync.py xxx xxx xxx --all

4. if you want to all files add args --all

1. follow the garmin steps

2. copy all your tcx files to TCX_OUT

3. Execute in the root directory:

   python3 run_page/tcx_to_garmin_sync.py ${{ secrets.GARMIN_SECRET_STRING_CN }} --is-cn

   example：

   python run_page/tcx_to_garmin_sync.py xxx --is-cn
   or Garmin Global
   python run_page/tcx_to_garmin_sync.py xxx

4. if you want to all files add args --all

1. follow the strava steps

2. copy all your gpx files to GPX_OUT

3. Execute in the root directory:

   python run_page/gpx_to_strava_sync.py ${client_id} ${client_secret}  ${strava_refresh_token}

   example：

   python run_page/gpx_to_strava_sync.py xxx xxx xxx
   or
   python run_page/tcx_to_strava_sync.py xxx xxx xxx --all

4. if you want to all files add args --all

1. follow the nike and strava steps
2. Execute in the root directory:

python run_page/nike_to_strava_sync.py ${nike_refresh_token} ${client_id} ${client_secret} ${strava_refresh_token}

example：

python run_page/nike_to_strava_sync.py eyJhbGciThiMTItNGIw******  xxx xxx xxx

1. finish garmin and strava setup

2. Execute in the root directory:

   python run_page/garmin_to_strava_sync.py  ${client_id} ${client_secret} ${strava_refresh_token} ${garmin_secret_string} --is-cn

   e.g.

   python run_page/garmin_to_strava_sync.py  xxx xxx xxx xx

1. finish garmin and strava setup, at the same time, you need to add additional strava config in GitHub Actions secret: secrets.STRAVA_EMAIL,secrets.STRAVA_PASSWORD,secrets.STRAVA_JWT, Note: STRAVA_JWT is superior to STRAVA_EMAIL and STRAVA_PASSWORD ,STRAVA_JWT is the strava_remember_token field of the Strava web login Cookie.

2. Execute in the root directory:

   python run_page/strava_to_garmin_sync.py ${{ secrets.STRAVA_CLIENT_ID }} ${{ secrets.STRAVA_CLIENT_SECRET }} ${{ secrets.STRAVA_CLIENT_REFRESH_TOKEN }}  ${{ secrets.GARMIN_SECRET_STRING }} ${{ secrets.STRAVA_EMAIL }} ${{ secrets.STRAVA_PASSWORD }}

   if your garmin account region is China, you need to execute the command:

   python run_page/strava_to_garmin_sync.py ${{ secrets.STRAVA_CLIENT_ID }} ${{ secrets.STRAVA_CLIENT_SECRET }} ${{ secrets.STRAVA_CLIENT_REFRESH_TOKEN }}  ${{ secrets.GARMIN_SECRET_STRING_CN }} ${{ secrets.STRAVA_EMAIL }} ${{ secrets.STRAVA_PASSWORD }}  ${{ secrets.STRAVA_JWT }} --is-cn

   If you want to add Garmin Device during sync, you should add --use_fake_garmin_device argument, this will add a Garmin Device (Garmin Forerunner 245 by default, and you can change device in garmin_device_adaptor.py) in synced Garmin workout record, this is essential when you want to sync the workout record to other APP like Keep, JoyRun etc.

   

   the final command will be:

   python run_page/strava_to_garmin_sync.py ${{ secrets.STRAVA_CLIENT_ID }} ${{ secrets.STRAVA_CLIENT_SECRET }} ${{ secrets.STRAVA_CLIENT_REFRESH_TOKEN }}  ${{ secrets.GARMIN_SECRET_STRING_CN }} ${{ secrets.STRAVA_EMAIL }} ${{ secrets.STRAVA_PASSWORD }} ${{ secrets.STRAVA_JWT }}--use_fake_garmin_device

   ps: when initializing for the first time, if you have a large amount of strava data, some data may fail to upload, just retry several times.

• If you only want to sync type running add args --only-run

Enter the following command in the terminal

python run_page/coros_sync.py 'your coros account' 'your coros password'

Modify run_data_sync.yml env.RUN_TYPE: coros

Set the Coros account information in github action

• configure the COROS_ACCOUNT , COROS_PASSWORD

  

Enter the following command in the terminal

python3 run_page/igpsport_sync.py 'your igpsport phone' 'password' --with-gpx

You can replace with-gpx with with-fit to acquire data in fit format.

Enter the following command in the terminal

python3 run_page/joyrun_sync.py 'your joyrun phone' 'verication code' --with-gpx

You can replace with-gpx with with-tcx to acquire data in tcx format.

Enter the following command in the terminal

python3 run_page/komoot_sync.py 'your komoot email' 'password' --with-gpx

Enter the following command in the terminal

python3 run_page/onelap_sync.py 'your onelap phone' 'password' --with-fit

Sync running activities from Intervals.icu. Downloads original FIT/GPX files.

1. Log in to Intervals.icu, go to Settings → Developer Settings to find your Athlete ID and create an API Key.

2. Execute in the root directory:

python run_page/intervals_icu_sync.py ${athlete_id} ${api_key}

If you want to sync all historical data (default is last 6 months):

python run_page/intervals_icu_sync.py ${athlete_id} ${api_key} --all

To specify a custom start date:

python run_page/intervals_icu_sync.py ${athlete_id} ${api_key} --start-date 2024-01-01

If your data comes from a Huawei/China device using the GCJ-02 coordinate system, add --gcj02 to fix the coordinate offset (converts GCJ-02 to WGS-84 in downloaded FIT/GPX/TCX files):

python run_page/intervals_icu_sync.py ${athlete_id} ${api_key} --gcj02

GitHub Actions

1. Change RUN_TYPE to intervals_icu in the run_data_sync.yml file
2. Add INTERVALS_ICU_ATHLETE_ID and INTERVALS_ICU_API_KEY to your GitHub repository secrets

• Generate SVG data display
• Display of results:Click to view、Click to view

python run_page/gen_svg.py -h

usage: gen_svg.py [-h] [--gpx-dir DIR] [--output FILE] [--language LANGUAGE] [--year YEAR] [--title TITLE] [--athlete NAME] [--special FILE] [--type TYPE]
                  [--background-color COLOR] [--track-color COLOR] [--track-color2 COLOR] [--text-color COLOR] [--special-color COLOR] [--special-color2 COLOR] [--units UNITS]
                  [--verbose] [--logfile FILE] [--special-distance DISTANCE] [--special-distance2 DISTANCE] [--min-distance DISTANCE] [--use-localtime] [--from-db]
                  [--github-style GITHUB_STYLE] [--circular-rings] [--circular-ring-color COLOR] [--empty-data-color COLOR] [--birth YYYY-MM]

options:
  -h, --help            show this help message and exit
  --gpx-dir DIR         Directory containing GPX files (default: current directory).
  --output FILE         Name of generated SVG image file (default: "poster.svg").
  --language LANGUAGE   Language (default: english).
  --year YEAR           Filter tracks by year; "NUM", "NUM-NUM", "all" (default: all years)
  --title TITLE         Title to display.
  --athlete NAME        Athlete name to display (default: "John Doe").
  --special FILE        Mark track file from the GPX directory as special; use multiple times to mark multiple tracks.
  --type TYPE           Type of poster to create (default: "grid", available: "grid", "circular", "github", "monthoflife").
  --background-color COLOR
                        Background color of poster (default: "#222222").
  --track-color COLOR   Color of tracks (default: "#4DD2FF").
  --track-color2 COLOR  Secondary color of tracks (default: none).
  --text-color COLOR    Color of text (default: "#FFFFFF").
  --special-color COLOR
                        Special track color (default: "#FFFF00").
  --special-color2 COLOR
                        Secondary color of special tracks (default: none).
  --units UNITS         Distance units; "metric", "imperial" (default: "metric").
  --verbose             Verbose logging.
  --logfile FILE
  --special-distance DISTANCE
                        Special Distance1 by km and color with the special_color
  --special-distance2 DISTANCE
                        Special Distance2 by km and corlor with the special_color2
  --min-distance DISTANCE
                        min distance by km for track filter
  --use-localtime       Use utc time or local time
  --from-db             activities db file
  --github-style GITHUB_STYLE
                        github svg style; "align-firstday", "align-monday" (default: "align-firstday").
  --birth YYYY-MM       Birth date in format YYYY-MM

Circular Type Options:
  --circular-rings      Draw distance rings.
  --circular-ring-color COLOR
                        Color of distance rings.

Github Type Options:
  --empty-data-color COLOR
                        Color for empty dates in github style poster (default: #444444)

Generate github style svg show

python run_page/gen_svg.py --from-db --title "${{ env.TITLE }}" --type github --athlete "${{ env.ATHLETE }}" --special-distance 10 --special-distance2 20 --special-color yellow --special-color2 red --output assets/github.svg --use-localtime --min-distance 0.5

If you want to change the display color of empty data(only github style), please use --empty-data-color:

python run_page/gen_svg.py --from-db --title "${{ env.TITLE }}" --type github --athlete "${{ env.ATHLETE }}" --special-distance 10 --special-distance2 20 --special-color yellow --special-color2 red --output assets/github.svg --use-localtime --min-distance 0.5 ----empty-data-color grey

Generate grid style svg show

python run_page/gen_svg.py --from-db --title "${{ env.TITLE_GRID }}" --type grid --athlete "${{ env.ATHLETE }}"  --output assets/grid.svg --min-distance 10.0 --special-color yellow --special-color2 red --special-distance 20 --special-distance2 40 --use-localtime

python run_page/gen_svg.py --from-db --type circular --use-localtime

Generate a "Runner Month of Life" visualization as if your entire life consisted of only 1000 months.

python3 run_page/gen_svg.py --from-db --type monthoflife --birth 1989-03 --special-distance 10 --special-distance2 20 --special-color '#f9d367'  --special-color2 '#f0a1a8' --output assets/mol.svg --use-localtime --athlete yihong0618 --title 'Runner Month of Life'

Generate your share png using GPT gpt-image-1(last one)

python run_page/auto_share_sync.py --api_key xxxxxxxxx  --base_url xxxxxxxx

If you want to generate a share png for a date

python run_page/auto_share_sync.py --api_key xxxxxxxxx --base_url xxxxxxxx --date 2023-11-11

If you want to auto gen in ci you can refer this link

For more display effects, see: https://github.com/flopp/GpxTrackPoster

1. vercel connects to your GitHub repo.

   
   

   

2. import repo

   
   

   

3. Awaiting completion of deployment

4. Visits

1. Login to Cloudflare dashboard.

2. Click Workers & Pages on the left side.

3. Click Create application and select Pages tab, connect your GitHub account and select running_page Repo, then click Begin setup.

4. Scroll down to Build settings, choose Create React App from Framework preset, and set Build output directory to dist.

5. Scroll down, click Environment variables (advanced), then add a variable like the below:

   Variable name = PYTHON_VERSION, Value = 3.11

6. Click Save and Deploy

1. Go to repository's Settings -> GitHub Pages -> Source, choose GitHub Actions

2. Go to the repository's Actions -> Workflows -> All Workflows, choose Run Data Sync from the left panel, and click Run workflow.

   • The Run Data Sync will update data and then trigger the Publish GitHub Pages workflow
   • Make sure the workflow runs without errors.

3. Open your website to check on the results

   • note if the website doesn't reflect the latest data, please refresh it by F5.
   • Some browsers (e.g. Chrome) won't refresh if there is a cache, you then need to use Ctrl+F5 (Windows) or Shift+Cmd+r (Mac) to force clearing the cache and reload the page.

4. make sure you have write permissions in Workflow permissions settings.

5. If you want to deploy your running_page to xxx.github.io instead of xxx.github.io/running_page or redirect your GitHub Pages to a custom domain, you need to do three things:

   • Rename your forked running_page repository to xxx.github.io, where xxx is your GitHub username
   • Modify the Build module in gh-pages.yml, remove ${{ github.event.repository.name }} and change to run: PATH_PREFIX=/ pnpm build
   • In config.yml, set your custom domain URL or leave empty

Actions source code The following steps need to be taken

1. change to your app type and info

   
   

   

2. Add your secret in repo Settings > Secrets (add only the ones you need).

   
   

   

3. My secret is as follows

   
   

   

4. Go to repository's Settings -> Code and automation -> Actions ->General, Scroll to the bottom, find Workflow permissions, choose the first option Read and write permissions, click Save.

Take the keep app as an example. Close the app after running, and then automatically trigger Actions to update the data.

1. Get actions id (need to apply token)

   curl https://api.github.com/repos/yihong0618/running_page/actions/workflows -H "Authorization: token d8xxxxxxxxxx" # change to your config

   

2. Binding shortcut instruction

   1. Get it via icloud running-page-shortcuts-template

   2. Modify the dictionary parameters in the following figure

   

3. Automation

When SAVE_DATA_IN_GITHUB_CACHE is set to true in the run_data_sync.yml file, the script can store fetched and intermediate data files in the GitHub Action Cache. This helps keep your GitHub commit history and directory clean.

If you are deploying using GitHub Pages, it is recommended to set this value to true, and set BUILD_GH_PAGES to true.