Skip to content

Latest commit

 

History

History
138 lines (126 loc) · 6.23 KB

README.md

File metadata and controls

138 lines (126 loc) · 6.23 KB

Contributors Forks Stargazers Issues LinkedIn License: MIT


Climbr

climbr dashboard demo

Visualize your rock climbing progression and trends.
Website · Screenshots · Wiki · Report Bug · Request Feature

About

Climbr is a utility that allows users to visualize and highlight their climbing strengths, weaknesses, and trends. From professionals to beginners, trad climbers to indoor boulderers, users can log climbing sessions from a selection of templates and instantly view their trends, patterns, and statistics with pre-configured Kibana dashboards.

In addition, Climbr provides booking insights on local gyms (Altitude Kanata, Altitude Gatineau, Coyote Rock Gym), to help users find the most optimal climbing time according to location, time of day, and time of week. Climbers can utilize this information to make socially responsible decisions. Those looking to minimize their risk whilst still staying active can easily find the off-peak hours of their local gym.

Technologies

python logo docker logo elastic logo kibana logo

Contributors

Peter Lam

Features

  • Log your climbing sessions and projects using yaml files
  • Visualize climbing trends, patterns, and statistics with dashboards
    • Climbing Stats and Metrics
      • Map of visited locations
      • Most common climbing discipline (Lead, Bouldering, Trad)
      • Grade counter
    • Climbing Trends and Progression
      • Progression in grades over time
      • What's your flash grade? project grade?
      • Strongest/Weakest climbing style? What areas should I improve?
    • Bookings
      • Busiest time to climb
      • Best time to climb to avoid crowds
      • Average bookings based on gym
  • Use data to influence your training regime and pinpoint weaknesses
  • Make responsible decisions based on booking data

Host Requirements

  • Docker 19+
  • Python 3.6+ (Optional)
    • Linux: sudo apt-get install python3 && python3 -m pip install -U pip
    • Windows: Ensure 'Add Python to PATH' is selected

Note: Climbr can be run without Docker. The following must be running on your host machine:

Quick Start

Climbr

  1. Open Command Prompt/Terminal
  2. Change directories to this the root of this repository
  3. Build and start up ElasticSearch, Kibana, and Climbr containers with:
    docker-compose up -d --build
    Note: This process may take a while to build
  4. Confirm that all containers are running
    • Run docker ps, the containers climbr_cli, climbr_kibana, and climbr_es should be running
    • You should be able to establish a connection to http://localhost:5601
    • If the link is not reachable, wait a couple minutes and try again
  5. Run the demo visualizations and data
    • If python is installed:
      1. Run the command python ./climbr.py demo
    • Otherwise:
      1. Copy the CONTAINER ID into your clipboard for the docker container of name climber_cli
      2. Run the following command to initialize the demo
        docker exec <CONTAINER_ID> bash -c "python ./climbr.py demo" 
  6. View Climbr visualizations at: http://localhost:5601/app/dashboard

Bookings

  1. Open Command Prompt/Terminal
  2. Change directories <PATH_TO_REPO>/web_scraper
  3. Run webscraper
    • Automated: start up bookings container by running
      docker-compose up -d --build
      Note: Confirm that the container climbr_bookings is running with the command docker ps
    • Manually: with Python
      python bookings.py ./bookings.py -l Altitude_Gatineau
  4. View Climbr visualizations at: http://localhost:5601/app/dashboard

Getting Started

Please visit the wiki for more information regarding system requirements, set-up, and usage.