Skip to content

[TRMNL] recipe badge service - #12022

Open
hossain-khan wants to merge 5 commits into
badges:masterfrom
hossain-khan:hk/add-trmnl-service
Open

[TRMNL] recipe badge service#12022
hossain-khan wants to merge 5 commits into
badges:masterfrom
hossain-khan:hk/add-trmnl-service

Conversation

@hossain-khan

@hossain-khan hossain-khan commented Jul 18, 2026

Copy link
Copy Markdown

Summary

Adding trmnl.com recipe badge service so that it's natively supported by shields.io - this service will complement existing custom badge service located at https://github.com/hossain-khan/trmnl-badges

This PR is inspired by community post at discord

Screenshot 2026-07-18 at 3 03 44 PM

https://img.shields.io/badge/TRMNL-F8654B?logo=trmnl&logoColor=fff&style=flat-square

Testing

Here are some local test results

trmnl-badge-preview html

trmnl-badge-preview.html

@github-actions

github-actions Bot commented Jul 18, 2026

Copy link
Copy Markdown
Contributor
Messages
📖 ✨ Thanks for your contribution to Shields, @hossain-khan!

Generated by 🚫 dangerJS against b5734a8

@hossain-khan hossain-khan changed the title Add TRMNL recipe badge service [Trmnl] recipe badge service Jul 18, 2026
@hossain-khan hossain-khan changed the title [Trmnl] recipe badge service [TRMNL] recipe badge service Jul 18, 2026
@jNullj jNullj self-assigned this Jul 21, 2026

@jNullj jNullj left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @hossain-khan and thank you for working on this.

I have a few review notes:

  • Live tests are preferred where applicable, i noticed multiple not found (404) tests using a nock, could these tests run with the live service? are there other tests that can be used with live tests?
  • I see you added a connections badge, I'm not very familiar with the TRMNL community but I tried to look for this terminology without success. Usually we don't transform much data from services. Can you point where this term is used?
  • For future contributors/maintainers, source for api endpoints can be found here. is there a chance you could make some form of short docs we could point at? it can be a webpage or even a .md file that sums up endpoint/rate limit etc...

@hossain-khan

Copy link
Copy Markdown
Author

Thanks for the feedback, I will take a look into it soon.

@hossain-khan

hossain-khan commented Jul 24, 2026

Copy link
Copy Markdown
Author

@jNullj thanks for the review.

Here is updates since the review.

  1. Service API is update to provide proper HTTP code. All nook mocking has been remove.
  2. Here is reference to "connection" terminology known to community and mention by the team at discord post
    Screenshot 2026-07-24 at 9 19 32 AM
  3. Added API docs and linked to source code index.ts#L437-L439

@LitoMore

Copy link
Copy Markdown
Member

@hossain-khan It looks like the API you're using is not the official one. Is it possible to fetch TRMNL's official API instead?

AFAIK, the TRMNL team is very active, and they are also very friendly towards open-source projects. Could you ask them for specific information about the actual rate limit?

@jNullj Does our project have any precedent for using third-party APIs?

@hossain-khan

Copy link
Copy Markdown
Author

I could use the official TRMNL api directly, however originally the idea was to reduce impact on the server with edge caching, deduping and address rate-limiting.

I have to check with TRMNL team to see if they natively do the same before I can commit to switching API server.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants