/openbeta-graphql

Climbing route GraphQL API

Primary LanguageTypeScriptGNU Affero General Public License v3.0AGPL-3.0

Build License

All Contributors

Climbing Route Catalog API

What is this?

OpenBeta GraphQL API allows other applications to access the climbing route catalog using any standard GraphQL clients.

Endpoint: https://api.openbeta.io

We recommend using an online playground to explore the API.

Learn more about GraphQL

Example query

Get all sub-areas at Smith Rock

query Example1 {
  areas(name: "Smith Rock") {
    area_name
    children {
      area_name
      metadata {
        lat
        lng
      }
    }
  }
}

# Result
{
  "data": {
    "areas": [
      {
        "area_name": "Smith Rock",
        "children": [
          {
            "area_name": "Aggro Gully",
            "metadata": {
              "lat": 44.36724,
              "lng": -121.14238
            }
          },
          {
            "area_name": "Angel Flight Crags",
            "metadata": {
              "lat": 44.5672,
              "lng": -122.1269
            }
          },
       ...
        ]
      }
  }
}

Development

Requirements:

Seed the development database

  1. Launch mongodb (the database) and mongo-express (the web-based admin console for mongo):
docker compose up -d
  1. Seed the database. You should see "Done." without any errors.
yarn install
yarn refresh-db

Browse the database: http://localhost:8081

Questions?

This project is under active development. Join us on Discord!

License

The source code is licensed under the Affero GPL v3.0 license.

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Kendra Gibbons

💻 🤔

This project follows the all-contributors specification. Contributions of any kind welcome!