digitallyinduced/ihp

Document how to utilize Github API with Github login

Open

#1,537 opened on Sep 27, 2022

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Haskell (221 forks)batch import
documentationhacktoberfest

Repository metrics

Stars
 (5,285 stars)
PR merge metrics
 (Avg merge 11h 20m) (21 merged PRs in 30d)

Description

After some adjustments Marc made to the Github Oauth Login, it's now possible to make full use of the Github API for IHP Pro apps. It's now only missing some documentation.

Todo

  • How to get accessToken as implicit parameter from user oauth session
  • How to override scope for Github Oauth apps (default is user:email which is the bare minimum for getting Oauth app working)
  • Example of how to write an http request to Github API with Wreq fetching Github user data

Contributor guide

Research direction
Explore the IHP codebase to understand how the access token is retrieved from the OAuth session. Then document the steps for using the GitHub API with Wreq, including overriding scopes.
Tech stack
haskell
Domain
documentationauthentication
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitIHP
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80