mazzzystar / mazzzystar/tinymind

Github API rate limiting issue

Open
#30 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
807
Forks
61
PR merge metrics
No merged PRs in 30d

Description

Github REST API enables the rate limit, in the current implementation, tinymind will fetch the content via GitHub API for each blog browsing, and it will easily reach the rate limit threshold.

There're two major options to fetch content from GitHub: Webhook or Fetch Queue. It'd better to investigate and improve the fetching logic.

https://docs.github.com/en/rest/using-the-rest-api/rate-limits-for-the-rest-api?apiVersion=2022-11-28
https://docs.github.com/en/rest/using-the-rest-api/best-practices-for-using-the-rest-api?apiVersion=2022-11-28

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

No file or test is named. Start by tracing the current GitHub REST API content-fetching entry point, then read the linked rate-limit and best-practices documentation and compare the webhook and fetch-queue options; done means browsing no longer causes the rate-limit threshold to be reached.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, typescript
Domain
api, backend
Issue type
Bug
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.