icipe-official / icipe-official/vectoratlas-software-code

Add an Altair GraphQL client to the site

Open
#41 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
2
Forks
8
Avg merge
5d 4h
Merged PRs (30d)
11

Description

Very technical users might want to explore the detail more closely or interact with the site directly from their packages. This can be done using the GraphQL api that is exposed for the website anyway. We can provide users with a more interactive experience by including the Altair GraphQL client and pointing it at the api. The middleware is here https://github.com/altair-graphql/altair/blob/master/packages/altair-express-middleware/README.md

At this point we would only utilise existing methods on the api - we may want to expand this further in future if this becomes a popular feature.

Acceptance Criteria

  • Users can navigate to a page with the graphql client in from the interactive map page.
  • Users can query the api using the graphql client.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start from the interactive map page and locate the site's GraphQL API entry point. Review the linked Altair Express middleware documentation, then verify that users can navigate to the client from the map and successfully run queries against the existing API methods.

Written by the indexing model from the issue text.

Assessment

Tech stack
graphql, typescript
Domain
api, frontend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.