[TRMNL] recipe badge service - #12022
Conversation
|
jNullj
left a comment
There was a problem hiding this comment.
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...
|
Thanks for the feedback, I will take a look into it soon. |
|
@jNullj thanks for the review. Here is updates since the review.
|
|
@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? |
|
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. |

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
Testing
Here are some local test results
trmnl-badge-preview.html