🌐 Web generator: type a username, see your black hole

Open
#12 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
65/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Active
Tech stack
github, javascript, node.js
Domain
api, full-stack

Research direction

Start with scripts/preview.js to understand the existing pipeline, then inspect api/hole.js, public/index.html and public/app.js. Build the API response and interactive generator described in the issue, including tests for invalid users and unknown themes. Done means the page works on mobile, the image endpoint returns SVG with the specified cache header, and the README links to the live generator.

Written by the indexing model from the issue text.

Description

enhancement help wanted iteration-2

Idea

No setup at all: a page where you type your username, pick theme and mode, watch the hole live and copy one Markdown line:

![My black hole](https://<host>/api/hole?user=your-username&mode=languages)

Where to start

  • api/hole.js (Vercel function): validate the query, call the same pipeline as scripts/preview.js, answer image/svg+xml with Cache-Control: s-maxage=14400.
  • public/index.html + public/app.js: input, theme/mode/style pickers, live <img> preview and a copy button.
  • Optional GITHUB_TOKEN env var for higher limits.

Done when

  • /api/hole with tests for bad input (invalid user, unknown theme)
  • Page works on mobile
  • README links to the live generator
Dominant language
JavaScript
Stars
0
Forks
0
Avg merge
1m
Merged PRs (30d)
9

Getting set up

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.

More from FelipeBeltranING/commit-horizon

All issues in FelipeBeltranING/commit-horizon

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.