running_page

(★ 4,503)

Make your own running home page

  • .dockerignore
  • .editorconfig
  • .gitignore
  • .prettierignore
  • .prettierrc.cjs
  • .python-version
  • .vercelignore
  • config-example.yaml
  • config.yml
  • CONTRIBUTING.md
  • Dockerfile
  • eslint.config.mjs
  • index.html
  • LICENSE
  • Makefile
  • nginx.conf
  • package.json
  • pdm.lock
  • pnpm-lock.yaml
  • pyproject.toml
  • README-CN.md
  • README.md
  • requirements-dev.txt
  • requirements.txt
  • test_real.py
  • test_tui.py
  • test_tui_app.py
  • tsconfig.json
  • uv.lock
  • vercel.json
  • vite-env.d.ts
  • vite.config.ts

# Installation Guide

1. Get the code
git clone https://github.com/yihong0618/running_page

Downloads the entire project code from GitHub to your computer.

cd running_page

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Node.js Node.js must be installed to use npm.
npm install -g corepack && corepack enable && pnpm install

Installs the package published on the npm registry globally — no need to clone the source.

After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t running_page:latest . --build-arg app=NRC --build-arg nike_refresh_token=""

Builds a runnable image based on the Dockerfile.

docker build -t running_page:latest . --build-arg app=Garmin --build-arg secret_string=""

Builds a runnable image based on the Dockerfile.

docker build -t running_page:latest . --build-arg app=Garmin-CN --build-arg secret_string=""

Builds a runnable image based on the Dockerfile.

docker build -t running_page:latest . --build-arg app=Strava --build-arg client_id="" --build-arg client_secret="" --build-arg refresh_token=""

Builds a runnable image based on the Dockerfile.

docker build -t running_page:latest . --build-arg app=Nike_to_Strava --build-arg nike_refresh_token="" --build-arg client_id="" --build-arg client_secret="" --build-arg refresh_token=""

Builds a runnable image based on the Dockerfile.

Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install -g corepack && corepack enable && pnpm install

Installs the package published on the npm registry globally — no need to clone the source.

pnpm develop

Starts the development/run server.

After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

5. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip3 install -r requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

6. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make tui

Compiles the code based on the generated build configuration to produce an executable.

If it finishes without errors, it worked. Try running the generated executable directly.

Pulled directly from this repo's README.

// repository documentation