Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Brand DNA: add a bring-your-own-key AI provider

Closed
  • Is something wrong?
#262 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
52/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Active
Tech stack
nextjs, typescript
Domain
ai, backend

Research direction

Start with docs/brand-dna-providers.md, then read lib/brand-dna/providers/mock-ai.ts, types.ts, and store/brand-dna-store.ts to understand the provider interface and existing on-device image preparation. Define request building and error handling with unit tests that use no network, and document key storage in docs/storage.md and docs/brand-dna-providers.md. Done means one real vision provider works end to end, keeps the key in IndexedDB, previews the image sent, and falls back to the on-device result on failure.

Written by the indexing model from the issue text.

Description

area: brand-dna difficulty: hard enhancement help wanted

Summary

Brand DNA has an on-device provider and a mock AI provider. Add a real AI provider where people paste their own API key (stored only in their browser, never sent anywhere except the model provider they choose) and the image is described by a vision model.

Where to look

  • docs/brand-dna-providers.md: how to add a provider
  • lib/brand-dna/providers/mock-ai.ts and types.ts
  • store/brand-dna-store.ts

Behaviour

  • The key lives in IndexedDB only, is never added to exports, project files or share links, and can be removed with one click.
  • Send only the downscaled image the on-device provider already prepares; show exactly what will be sent before the first request.
  • Failures (bad key, rate limit, network) show a clear message and fall back to the on-device result.

Acceptance criteria

  • The provider works end to end with one real vision API (name it in the PR).
  • docs/storage.md and docs/brand-dna-providers.md describe where the key lives.
  • Unit tests cover request building and error handling without network access.

Getting started: fork the repo, then pnpm install and pnpm dev (Node 22+, pnpm 11, no API keys). Before opening a PR, run pnpm typecheck && pnpm test && pnpm lint && pnpm format:check && pnpm check:dashes && pnpm build (CI fails on unformatted files, so pnpm format first). See CONTRIBUTING.md and the first contribution walkthrough.

Everything needed is in the repository. This doesn't need maintainer access, secrets or paid services. Comment below to claim it, and ask questions here any time.

Dominant language
TypeScript
Stars
11
Forks
3
Avg merge
4h 4m
Merged PRs (30d)
74

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 yakew7/DesignHub

All issues in yakew7/DesignHub

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.