Add Miniflux
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 78/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- javascript
- Domain
- api
Research direction
Read docs/ADDING_APPS.md, then open the gitea definition in src/catalog/apps/batch-19.js as the url-field pattern to copy. Check the Miniflux API docs for the /v1 base URL, the X-Auth-Token header and GET /me, and add the definition to the most fitting file in src/catalog/apps/. Done when npm run validate and npm test pass, npm run logos -- miniflux produces the logo, and the help text walks users to the API key in numbered steps.
Written by the indexing model from the issue text.
Description
Add Miniflux to the catalog. It's a popular self-hosted app and a good first contribution: Conector already supports apps on your own server through a url field.
API documentation: https://miniflux.app/docs/api.html
What we know so far (check it against the docs before relying on it):
- Base URL:
{url}/v1, where{url}is a field withformat: "url"(see thegiteaapp insrc/catalog/apps/batch-19.jsfor an example). - Authentication: An API key (Settings → API Keys), sent in the
X-Auth-Tokenheader. - Connection test:
GET /mereturns the user. - What agents could do with it: Read unread entries, star them, and add or refresh feeds.
How to add it
- Follow docs/ADDING_APPS.md: add the definition to the most fitting file in
src/catalog/apps/, with help text that leads people to the key in a few numbered steps. - Run
npm run validateandnpm test, and generate the logo withnpm run logos -- <app id>. - If you run Miniflux yourself, connect it in a local Conector and try a couple of requests from your agent. Say in the pull request what you tested.
Comment here if you'd like to take it, so nobody else starts the same work.
- Dominant language
- JavaScript
- Stars
- 1
- Forks
- 1
- Avg merge
- 19h 5m
- Merged PRs (30d)
- 26
Getting set up
- Ships a Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
awesome-dsh-plugin/awesome-dsh-plugin#9184 ·
Maintainers usually reply within 1 day
-
RpcTest.makeClient: accept disableFatalDefectsPossibly taken @effect-bot claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Effect-TS/effect#9893 · 3 comments ·
Maintainers usually reply within 1 day
-
0.2.1-rc.3 compatibility: 21 peer ranges enumerate exact versions, so rc.3 is rejectedPossibly taken A pull request linked to this issue is open or already merged. Open
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
NanmiCoder/dsh-agent-teams#277 ·
Maintainers usually reply within 1 day
-
[ordering-review] workshop order graph: 1 confirmed ordering problem, 3 cycles are false positivesOpen
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
githubnext/gh-aw-workshop#4943 · 1 comment ·
Maintainers usually reply within 1 day