lpu-belt-explorer

An interactive web app for exploring the Lockpickers United belt ranking system.

LIVE - LPU Belts Website

Table of Contents

• How to Contribute
• Getting Started (Local Setup)
  • Run Locally
  • Github Hooks
  • Build/Deploy
  • Import/Exort Data
• Links

How To Contribute

• Data contributions
  • Photos of Locks
  • Submit Locks not on the site
  • For other data contributions, ask in LPU Discord
• Code/Feature contributions
  One of the following
  • Submit an issue and discuss first
  • Discuss in LPU Discord #belt-explorer Channel

Getting Started (Local Setup)

• Install node - v22 is needed
• Install yarn - it's used as a package manager
  • npm install -g yarn
• Clone repo

Run locally

• On initial setup and package.json changes
  • Run yarn install inside the parent folder 'lpu-belt-explorer'
• To stand up locally
  • Run yarn dev

Github Hooks

• Build-N-Deploy
  • Trigger: On Push to Main
  • Action(s): Builds application with yarn ci-build then kicks off gh page action to deploy
• Import
  • Trigger: Workflow Dispatch
  • Action(s): Runs yarn import which updates the data then auto commits back to repository
• PR
  • Trigger: On Pull Request
  • Action(s): Gets PR ready with yarn ci-pr which lints and builds application

Build/Deploy

Several commmands are linked together for this, here is the shortened version

• yarn ci-build

Import/Export data

For import, place a data.csv in the scripts folder and run:

yarn import

For export, run one of the following:

• yarn exportCsv
• yarn exportMd
• yarn exportHtml

There's also a Dan import

yarn import-dan

Links

• LPU Belts Website
• Github Repo
• Discord
• Reddit
• Wiki
• Belt Ranking Information