@hangtime/climbing-boards 1.0.0

package/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <https://unlicense.org>

package/README.md

@@ -0,0 +1,155 @@
+# Climbing Boards
+
+A GeoJSON dataset tracking all climbing training/system boards worldwide,
+including MoonBoard, Kilter Board, Tension Board, Grasshopper Board, Decoy
+Board, So iLL Board, Touchstone Board, Aurora Board, and 12Climb Board. This
+dataset is automatically updated daily through GitHub Actions.
+
+[Explore all system boards on GeoJSON.io](https://geojson.io/#id=github:Stevie-Ray/hangtime-climbing-boards/blob/main/geojson/combined.geojson)
+
+[![Climbing Boards](https://repository-images.githubusercontent.com/941517323/94c21be3-b32e-4ce3-a2d0-4284ec1e7781)](https://geojson.io/#id=github:Stevie-Ray/hangtime-climbing-boards/blob/main/geojson/combined.geojson)
+
+## Data Sources
+
+The repository collects data from multiple climbing board applications and
+converts it to GeoJSON, a lightweight, open standard format that's perfect for
+mapping applications and geographic data visualization. Explore individual
+boards on GeoJSON.io:
+
+- [MoonBoard](https://geojson.io/#id=github:Stevie-Ray/hangtime-climbing-boards/blob/main/geojson/moonboard.geojson)
+- [Kilter Board](https://geojson.io/#id=github:Stevie-Ray/hangtime-climbing-boards/blob/main/geojson/kilterboardapp.geojson)
+- [Tension Board](https://geojson.io/#id=github:Stevie-Ray/hangtime-climbing-boards/blob/main/geojson/tensionboardapp2.geojson)
+- [Grasshopper Board](https://geojson.io/#id=github:Stevie-Ray/hangtime-climbing-boards/blob/main/geojson/grasshopperboardapp.geojson)
+- [Decoy Board](https://geojson.io/#id=github:Stevie-Ray/hangtime-climbing-boards/blob/main/geojson/decoyboardapp.geojson)
+- [So iLL Board](https://geojson.io/#id=github:Stevie-Ray/hangtime-climbing-boards/blob/main/geojson/soillboardapp.geojson)
+- [Touchstone Board](https://geojson.io/#id=github:Stevie-Ray/hangtime-climbing-boards/blob/main/geojson/touchstoneboardapp.geojson)
+- [Aurora Board](https://geojson.io/#id=github:Stevie-Ray/hangtime-climbing-boards/blob/main/geojson/auroraboardapp.geojson)
+- [12Climb Board](https://geojson.io/#id=github:Stevie-Ray/hangtime-climbing-boards/blob/main/geojson/12climb.geojson)
+
+## Data Structure
+
+The `/data` directory contains:
+
+- Raw JSON location data from each source
+- Scraped data from various Aurora Climbing API endpoints
+
+The `/geojson` directory contains:
+
+- Individual GeoJSON files for each climbing board type
+- A combined GeoJSON file with all locations
+
+The `/api` directory contains:
+
+- API client implementations for each climbing board service
+- Authentication and data fetching logic
+
+The `/interfaces` directory contains:
+
+- TypeScript type definitions and interfaces
+- Data model specifications for the application
+
+The `/models` directory contains:
+
+- Client models for API interactions and data handling
+- Data transformation and validation models
+
+## Automation
+
+This repository uses GitHub Actions to:
+
+- Scrape the latest location data daily
+- Convert the data to GeoJSON format
+- Combine all sources into a single GeoJSON file
+- Automatically commit, push and publish updates
+
+## Development
+
+### Prerequisites
+
+- Node.js 22 / Deno / Bun
+
+### Available Scripts
+
+```bash
+# Install dependencies
+npm ci
+
+# Scrape data from board APIs
+npm run scrape
+
+# Convert scraped data to GeoJSON
+npm run convert
+
+# Combine all GeoJSON files
+npm run combine
+
+# Run the complete build process
+npm run build
+
+# Watch for TypeScript changes during development
+npm run dev
+```
+
+### Authentication
+
+Required to get MoonBoard and Kilter Board locations. To get detailed
+information about Aurora Boards such as (Tension, Grasshoper etc.) including the
+gym's address, board angle, or rotatability status, you need to provide your
+credentials through environment variables. Each climbing board app requires its
+own set of login credentials. The scraper will only fetch additional details for
+the specific apps where you provide valid login details.
+
+**Important Legal Notice**: Before using this scraper with credentials, you
+must:
+
+1. Have a valid account and have explicitly accepted the Terms of Use for each
+   platform.
+2. Ensure your use of this tool complies with the platform's terms of service
+3. Be aware that this tool makes authenticated API requests to these services
+
+**Setup Instructions**:
+
+1. Copy the `.env.example` file to `.env`:
+
+```bash
+cp .env.example .env
+```
+
+2. Fill in your credentials in the `.env` file:
+
+```bash
+# Aurora Climbing Boards (Tension, Grasshoper etc.)
+TENSIONBOARDAPP_USERNAME=your_username
+TENSIONBOARDAPP_PASSWORD=your_password
+
+# Kilter Boards (requires authentication for location data)
+KILTERBOARDAPP_USERNAME=your_username
+KILTERBOARDAPP_PASSWORD=your_password
+
+# MoonBoard (requires authentication for location data)
+MOONBOARD_USERNAME=your_username
+MOONBOARD_PASSWORD=your_password
+
+# Add credentials for other boards as needed
+```
+
+**API Usage Safeguards**: The scraper includes built-in protections:
+
+- Rate limiting (30 requests per minute per board)
+- Automatic request throttling
+- Retry mechanism with exponential backoff for rate limit errors
+- High usage warnings (triggers at 80% of rate limit)
+- Error handling for authentication and API issues
+
+**Note**: While the scraper implements rate limiting and other safeguards, you
+are still responsible for ensuring your usage complies with each service's terms
+of use.
+
+## Credits
+
+Forked from
+[Georift/climbing-board-locations](https://github.com/Georift/climbing-board-locations)
+
+## License
+
+Unlicense