Skip to content

armgit / mimik

Public Imported from GitHub
0

🎬 A browser extension and desktop app that turns your clicks into step-by-step guides with annotated screenshots 📖

feat: share one GitHub card and add an About section to the options page

Luis Ortize560d1408ce3
diff --git a/apps/desktop/src/renderer/settings/GeneralSettings.tsx b/apps/desktop/src/renderer/settings/GeneralSettings.tsx
index 1b3e70f..95dcbc8 100644
--- a/apps/desktop/src/renderer/settings/GeneralSettings.tsx
+++ b/apps/desktop/src/renderer/settings/GeneralSettings.tsx
@@ -1,13 +1,11 @@
import { i18n } from '@mimik/core/env';
-import { Button, Switch } from '@mimik/ui';
-import { Bug, Languages, Power, RefreshCw, Star } from 'lucide-react';
+import { Button, GitHubCard, Switch } from '@mimik/ui';
+import { Languages, Power, RefreshCw } from 'lucide-react';
import { useEffect, useState } from 'react';
import { AppLanguage } from './AppLanguage';
import { Card } from './Card';
import { Row } from './Row';
-const REPO_URL = 'https://github.com/westpoint-io/mimik';
-
const LOGIN_HINT = navigator.userAgent.includes('Mac') ? 'desktop.startAtLoginHintMac' : 'desktop.startAtLoginHint';
export function GeneralSettings({ onSaved }: { onSaved: () => void }) {
@@ -49,20 +47,7 @@ export function GeneralSettings({ onSaved }: { onSaved: () => void }) {
</Row>
</Card>
- <Card icon={Star} title={i18n.t('desktop.cardGithub')}>
- <Row label={i18n.t('settings.starCtaTitle')} hint={i18n.t('settings.starCtaMessage')}>
- <Button variant="outline" size="sm" onClick={() => window.open(REPO_URL, '_blank')}>
- <Star size={14} />
- {i18n.t('settings.starOnGithub')}
- </Button>
- </Row>
- <Row label={i18n.t('desktop.bugTitle')} hint={i18n.t('desktop.bugHint')}>
- <Button variant="outline" size="sm" onClick={() => window.open(`${REPO_URL}/issues`, '_blank')}>
- <Bug size={14} />
- {i18n.t('desktop.reportBug')}
- </Button>
- </Row>
- </Card>
+ <GitHubCard />
</>
);
}
diff --git a/apps/extension/src/ui/shared/SettingsFooter.tsx b/apps/extension/src/ui/shared/SettingsFooter.tsx
index 5ac1b17..de205fb 100644
--- a/apps/extension/src/ui/shared/SettingsFooter.tsx
+++ b/apps/extension/src/ui/shared/SettingsFooter.tsx
@@ -1,48 +1,15 @@
import { i18n } from '@mimik/core/env';
-import { Bug, ChevronRight, Shield, Star } from 'lucide-react';
+import { GitHubCard } from '@mimik/ui';
+import { Shield } from 'lucide-react';
export function SettingsFooter() {
return (
<>
+ <GitHubCard />
<div className="flex items-start gap-2 px-3 py-2.5 rounded-lg bg-secondary text-[10px] text-muted-foreground leading-relaxed">
<Shield size={12} className="shrink-0 mt-0.5 text-accent" />
<span>{i18n.t('settings.privacyNotice')}</span>
</div>
-
- <a
- href="https://github.com/westpoint-io/mimik/issues"
- target="_blank"
- rel="noopener noreferrer"
- className="flex items-center gap-2.5 px-3 py-2.5 rounded-lg border border-border text-[11px] font-medium text-muted-foreground hover:text-foreground hover:border-accent transition-colors"
- >
- <Bug size={13} className="shrink-0" />
- <span>{i18n.t('settings.bugReport')}</span>
- </a>
-
- <div className="flex items-center gap-3.5 border border-border rounded-[10px] p-3.5">
- <svg width="44" height="44" viewBox="20 55 160 108" className="shrink-0">
- <rect x="30" y="95" width="140" height="68" rx="8" fill="#1E1B4B" />
- <path d="M30 95 L30 80 Q30 58, 100 58 Q170 58, 170 80 L170 95 Z" fill="#3730A3" />
- <rect x="30" y="93" width="140" height="3" fill="#C7D2FE" />
- <path d="M68 122 Q76 112 84 122" stroke="#C7D2FE" strokeWidth="5" fill="none" strokeLinecap="round" />
- <path d="M116 122 Q124 112 132 122" stroke="#C7D2FE" strokeWidth="5" fill="none" strokeLinecap="round" />
- <path d="M84 138 Q100 148 116 138" stroke="#C7D2FE" strokeWidth="3.5" fill="none" strokeLinecap="round" />
- </svg>
- <div className="flex-1 min-w-0">
- <p className="text-xs font-bold text-foreground mb-0.5">{i18n.t('settings.starCtaTitle')}</p>
- <p className="text-[10px] text-muted-foreground leading-relaxed mb-2">{i18n.t('settings.starCtaMessage')}</p>
- <a
- href="https://github.com/westpoint-io/mimik"
- target="_blank"
- rel="noopener noreferrer"
- className="inline-flex items-center gap-1.5 px-3 py-1.5 rounded-lg bg-secondary text-[10px] font-semibold text-accent hover:bg-accent hover:text-white transition-colors"
- >
- <Star size={11} fill="#FBBF24" className="text-[#FBBF24]" />
- {i18n.t('settings.starOnGithub')}
- <ChevronRight size={11} />
- </a>
- </div>
- </div>
</>
);
}
diff --git a/apps/extension/src/ui/shared/SettingsView.tsx b/apps/extension/src/ui/shared/SettingsView.tsx
index d642702..30c2f19 100644
--- a/apps/extension/src/ui/shared/SettingsView.tsx
+++ b/apps/extension/src/ui/shared/SettingsView.tsx
@@ -148,6 +148,7 @@ export function SettingsView({ onBack, layout = 'column' }: SettingsViewProps) {
</SettingsCard>
),
'api-keys': <ApiKeysSettings state={keys} validate={validateApiKey} title={i18n.t('settings.apiKeys')} />,
+ about: <SettingsFooter />,
};
if (layout === 'sections') {
diff --git a/apps/extension/src/ui/shared/lib/settings-section.ts b/apps/extension/src/ui/shared/lib/settings-section.ts
index ab86a06..901bf18 100644
--- a/apps/extension/src/ui/shared/lib/settings-section.ts
+++ b/apps/extension/src/ui/shared/lib/settings-section.ts
@@ -1,4 +1,4 @@
-import { EyeOff, ImageIcon, Keyboard, KeyRound, Sparkles } from 'lucide-react';
+import { EyeOff, ImageIcon, Info, Keyboard, KeyRound, Sparkles } from 'lucide-react';
export const SETTINGS_SECTIONS = [
{ id: 'ai', label: 'settings.aiSection', Icon: Sparkles },
@@ -6,6 +6,7 @@ export const SETTINGS_SECTIONS = [
{ id: 'smart-blur', label: 'settings.smartBlur', Icon: EyeOff },
{ id: 'keyboard', label: 'settings.cardKeyboard', Icon: Keyboard },
{ id: 'api-keys', label: 'settings.apiKeys', Icon: KeyRound },
+ { id: 'about', label: 'settings.aboutSection', Icon: Info },
] as const;
export type SettingsSection = (typeof SETTINGS_SECTIONS)[number]['id'];
diff --git a/packages/locales/de.yml b/packages/locales/de.yml
index a94c921..05e4040 100644
--- a/packages/locales/de.yml
+++ b/packages/locales/de.yml
@@ -178,7 +178,8 @@ settings:
saved: Gespeichert
smartBlur: Smart Blur
privacyNotice: "Schlüssel und Audio gehen nur an den gewählten Anbieter."
- bugReport: "Fehler gefunden? Melde ihn auf GitHub"
+ reportBug: "Fehler melden"
+ aboutSection: "Über Mimik"
starCtaTitle: "Gefällt dir, was du siehst?"
starCtaMessage: "Ein Stern auf GitHub hilft anderen, Mimik zu finden."
starOnGithub: "Auf GitHub mit Stern markieren"
@@ -229,8 +230,8 @@ desktop:
modeWindow: Fenster
modeScreen: Bildschirm
modeArea: Bereich
- startSheetTitle: Aufnahme starten
drawArea: "Ziehen, um den Aufnahmebereich zu zeichnen"
+ startSheetTitle: Aufnahme starten
permissionsTitle: "Mimik das Aufnehmen erlauben"
permissionsIntro: "Mimik braucht zwei Berechtigungen, bevor es aufnehmen kann."
permissionAccessibility: "Bedienungshilfen"
@@ -256,10 +257,6 @@ desktop:
version: "Version $1"
versionHint: "Mimik sucht bei jedem Start nach Updates."
checkUpdates: "Nach Updates suchen"
- cardGithub: "Mimik auf GitHub"
- bugTitle: "Einen Fehler gefunden?"
- bugHint: "Beschreib, was passiert ist, und wir sehen es uns an."
- reportBug: "Fehler melden"
trayQuit: "Mimik beenden"
trayRecording: "Mimik nimmt auf. Zum Beenden klicken."
cannotRecord: "Mimik kann nicht aufnehmen"
diff --git a/packages/locales/en.yml b/packages/locales/en.yml
index c7b8ca5..5e90576 100644
--- a/packages/locales/en.yml
+++ b/packages/locales/en.yml
@@ -192,7 +192,8 @@ settings:
modelsFound: "$1 models available"
smartBlur: "Smart blur"
privacyNotice: "Keys and audio go only to the provider you choose."
- bugReport: "Found a bug? Report it on GitHub"
+ reportBug: "Report a bug"
+ aboutSection: "About"
starCtaTitle: "Like what you see?"
starCtaMessage: "A GitHub star helps other people find Mimik."
starOnGithub: Star on GitHub
@@ -229,8 +230,8 @@ desktop:
modeWindow: Window
modeScreen: Screen
modeArea: Area
- startSheetTitle: Start a capture
drawArea: "Drag to draw the capture area"
+ startSheetTitle: Start a capture
permissionsTitle: "Allow Mimik to record"
permissionsIntro: "Mimik needs two permissions before it can record."
permissionAccessibility: "Accessibility"
@@ -256,10 +257,6 @@ desktop:
version: "Version $1"
versionHint: "Mimik looks for updates each time it starts."
checkUpdates: "Check for updates"
- cardGithub: "Mimik on GitHub"
- bugTitle: "Found a bug?"
- bugHint: "Tell us what happened and we'll look into it."
- reportBug: "Report a bug"
trayQuit: "Quit Mimik"
trayRecording: "Mimik is recording. Click to finish."
cannotRecord: "Mimik cannot record"
diff --git a/packages/locales/es.yml b/packages/locales/es.yml
index 8d3aeec..b7eb10d 100644
--- a/packages/locales/es.yml
+++ b/packages/locales/es.yml
@@ -192,7 +192,8 @@ settings:
modelsFound: "$1 modelos disponibles"
smartBlur: Desenfoque inteligente
privacyNotice: "Las claves y el audio solo van al proveedor que elijas."
- bugReport: "¿Has encontrado un error? Notifícalo en GitHub"
+ reportBug: "Informar de un error"
+ aboutSection: "Acerca de"
starCtaTitle: "¿Te gusta Mimik?"
starCtaMessage: "Una estrella en GitHub ayuda a que más gente encuentre Mimik."
starOnGithub: "Dar una estrella en GitHub"
@@ -229,8 +230,8 @@ desktop:
modeWindow: Ventana
modeScreen: Pantalla
modeArea: Área
- startSheetTitle: Iniciar una captura
drawArea: "Arrastra para dibujar el área de captura"
+ startSheetTitle: Iniciar una captura
permissionsTitle: "Permite que Mimik grabe"
permissionsIntro: "Mimik necesita dos permisos antes de poder grabar."
permissionAccessibility: "Accesibilidad"
@@ -256,10 +257,6 @@ desktop:
version: "Versión $1"
versionHint: "Mimik busca actualizaciones cada vez que se inicia."
checkUpdates: "Buscar actualizaciones"
- cardGithub: "Mimik en GitHub"
- bugTitle: "¿Encontraste un error?"
- bugHint: "Cuéntanos qué pasó y lo revisaremos."
- reportBug: "Informar de un error"
trayQuit: "Salir de Mimik"
trayRecording: "Mimik está grabando. Haz clic para terminar."
cannotRecord: "Mimik no puede grabar"
diff --git a/packages/locales/fr.yml b/packages/locales/fr.yml
index 5886e34..188cc11 100644
--- a/packages/locales/fr.yml
+++ b/packages/locales/fr.yml
@@ -192,7 +192,8 @@ settings:
modelsFound: "$1 modèles disponibles"
smartBlur: Flou intelligent
privacyNotice: "Les clés et l'audio ne vont qu'au fournisseur choisi."
- bugReport: "Un bug ? Signalez-le sur GitHub"
+ reportBug: "Signaler un bug"
+ aboutSection: "À propos"
starCtaTitle: "Vous aimez Mimik ?"
starCtaMessage: "Une étoile sur GitHub aide d'autres personnes à découvrir Mimik."
starOnGithub: "Mettre une étoile sur GitHub"
@@ -229,8 +230,8 @@ desktop:
modeWindow: Fenêtre
modeScreen: Écran
modeArea: Zone
- startSheetTitle: Démarrer une capture
drawArea: "Faites glisser pour tracer la zone de capture"
+ startSheetTitle: Démarrer une capture
permissionsTitle: "Autoriser Mimik à enregistrer"
permissionsIntro: "Mimik a besoin de deux autorisations avant de pouvoir enregistrer."
permissionAccessibility: "Accessibilité"
@@ -256,10 +257,6 @@ desktop:
version: "Version $1"
versionHint: "Mimik recherche les mises à jour à chaque démarrage."
checkUpdates: "Rechercher des mises à jour"
- cardGithub: "Mimik sur GitHub"
- bugTitle: "Vous avez trouvé un bug ?"
- bugHint: "Dites-nous ce qui s'est passé et nous regarderons."
- reportBug: "Signaler un bug"
trayQuit: "Quitter Mimik"
trayRecording: "Mimik enregistre. Cliquez pour terminer."
cannotRecord: "Mimik ne peut pas enregistrer"
diff --git a/packages/locales/pt-BR.yml b/packages/locales/pt-BR.yml
index f1421e5..302cc4b 100644
--- a/packages/locales/pt-BR.yml
+++ b/packages/locales/pt-BR.yml
@@ -192,7 +192,8 @@ settings:
modelsFound: "$1 modelos disponíveis"
smartBlur: Desfoque inteligente
privacyNotice: "Chaves e áudio vão só para o provedor que você escolher."
- bugReport: "Encontrou um bug? Informe no GitHub"
+ reportBug: "Relatar um erro"
+ aboutSection: "Sobre"
starCtaTitle: "Gostou do Mimik?"
starCtaMessage: "Uma estrela no GitHub ajuda outras pessoas a encontrar o Mimik."
starOnGithub: "Deixar uma estrela no GitHub"
@@ -229,8 +230,8 @@ desktop:
modeWindow: Janela
modeScreen: Tela
modeArea: Área
- startSheetTitle: Iniciar uma captura
drawArea: "Arraste para desenhar a área de captura"
+ startSheetTitle: Iniciar uma captura
permissionsTitle: "Permita que o Mimik grave"
permissionsIntro: "O Mimik precisa de duas permissões antes de gravar."
permissionAccessibility: "Acessibilidade"
@@ -256,10 +257,6 @@ desktop:
version: "Versão $1"
versionHint: "O Mimik procura atualizações sempre que é iniciado."
checkUpdates: "Procurar atualizações"
- cardGithub: "Mimik no GitHub"
- bugTitle: "Encontrou um erro?"
- bugHint: "Conte o que aconteceu e vamos investigar."
- reportBug: "Relatar um erro"
trayQuit: "Sair do Mimik"
trayRecording: "O Mimik está gravando. Clique para terminar."
cannotRecord: "O Mimik não consegue gravar"
diff --git a/packages/locales/ru.yml b/packages/locales/ru.yml
index a23702d..bc776fa 100644
--- a/packages/locales/ru.yml
+++ b/packages/locales/ru.yml
@@ -192,7 +192,8 @@ settings:
modelsFound: "Доступно моделей: $1"
smartBlur: Умное размытие
privacyNotice: Ваши ключи и аудио отправляются только выбранному вами провайдеру. Больше ничего не покидает ваш браузер.
- bugReport: Нашли баг? Сообщите на GitHub
+ reportBug: "Сообщить об ошибке"
+ aboutSection: "О Mimik"
starCtaTitle: "Нравится то, что вы видите?"
starCtaMessage: "Звезда на GitHub помогает другим находить Mimik и поддерживает нас!"
starOnGithub: Поставить звезду на GitHub
@@ -229,8 +230,8 @@ desktop:
modeWindow: Окно
modeScreen: Экран
modeArea: Область
- startSheetTitle: Начать запись
drawArea: "Потяните, чтобы выделить область записи"
+ startSheetTitle: Начать запись
permissionsTitle: Разрешите Mimik записывать
permissionsIntro: "Mimik нужны два разрешения, прежде чем начать запись."
permissionAccessibility: Универсальный доступ
@@ -256,10 +257,6 @@ desktop:
version: Версия $1
versionHint: Mimik проверяет обновления при каждом запуске.
checkUpdates: Проверить обновления
- cardGithub: "Mimik на GitHub"
- bugTitle: "Нашли ошибку?"
- bugHint: "Расскажите, что произошло, и мы разберёмся."
- reportBug: "Сообщить об ошибке"
trayQuit: Выйти из Mimik
trayRecording: "Mimik записывает. Нажмите, чтобы закончить."
cannotRecord: Mimik не может записывать
diff --git a/packages/locales/zh-CN.yml b/packages/locales/zh-CN.yml
index a98e954..7f5bc82 100644
--- a/packages/locales/zh-CN.yml
+++ b/packages/locales/zh-CN.yml
@@ -192,7 +192,8 @@ settings:
modelsFound: "$1 个可用模型"
smartBlur: 智能模糊
privacyNotice: "密钥和音频只会发送给你选择的提供商。"
- bugReport: "发现问题?在 GitHub 上报告"
+ reportBug: "报告问题"
+ aboutSection: "关于"
starCtaTitle: "喜欢 Mimik 吗?"
starCtaMessage: "在 GitHub 上加星能帮助更多人发现 Mimik。"
starOnGithub: 在 GitHub 上加星
@@ -229,8 +230,8 @@ desktop:
modeWindow: 窗口
modeScreen: 屏幕
modeArea: 区域
- startSheetTitle: 开始捕获
drawArea: "拖动以绘制捕获区域"
+ startSheetTitle: 开始捕获
permissionsTitle: "允许 Mimik 录制"
permissionsIntro: "Mimik 需要两项权限才能开始录制。"
permissionAccessibility: "辅助功能"
@@ -256,10 +257,6 @@ desktop:
version: "版本 $1"
versionHint: "Mimik 每次启动时都会检查更新。"
checkUpdates: "检查更新"
- cardGithub: "GitHub 上的 Mimik"
- bugTitle: "发现问题?"
- bugHint: "告诉我们发生了什么,我们会跟进处理。"
- reportBug: "报告问题"
trayQuit: "退出 Mimik"
trayRecording: "Mimik 正在录制。点击即可完成。"
cannotRecord: "Mimik 无法录制"
diff --git a/packages/ui/src/common/components/GitHubCard.tsx b/packages/ui/src/common/components/GitHubCard.tsx
new file mode 100644
index 0000000..6f922ea
--- /dev/null
+++ b/packages/ui/src/common/components/GitHubCard.tsx
@@ -0,0 +1,36 @@
+import { i18n } from '@mimik/core/env';
+import { Bug, Star } from 'lucide-react';
+import { Button } from '../../components/ui/button';
+import { tabs } from '../../env';
+import { MascotIcon } from './MascotIcon';
+
+const REPO_URL = 'https://github.com/westpoint-io/mimik';
+
+export function GitHubCard() {
+ return (
+ <div className="flex items-center gap-3.5 rounded-xl border border-border bg-card p-3.5">
+ <span className="flex size-14 shrink-0 items-center justify-center rounded-[14px] bg-secondary">
+ <MascotIcon size={36} />
+ </span>
+ <div className="min-w-0 flex-1">
+ <p className="text-[13px] font-bold text-foreground">{i18n.t('settings.starCtaTitle')}</p>
+ <p className="mt-0.5 text-[11.5px] leading-snug text-muted-foreground">{i18n.t('settings.starCtaMessage')}</p>
+ <div className="mt-2.5 flex flex-wrap gap-2">
+ <Button size="sm" onClick={() => void tabs.create(REPO_URL)} className="rounded-lg text-[12px] font-semibold">
+ <Star size={14} className="fill-amber-400 text-amber-400" />
+ {i18n.t('settings.starOnGithub')}
+ </Button>
+ <Button
+ variant="outline"
+ size="sm"
+ onClick={() => void tabs.create(`${REPO_URL}/issues`)}
+ className="rounded-lg text-[12px] font-semibold"
+ >
+ <Bug size={14} />
+ {i18n.t('settings.reportBug')}
+ </Button>
+ </div>
+ </div>
+ </div>
+ );
+}
diff --git a/packages/ui/src/index.ts b/packages/ui/src/index.ts
index dc88827..c763d00 100644
--- a/packages/ui/src/index.ts
+++ b/packages/ui/src/index.ts
@@ -8,6 +8,7 @@ export { useKeyCheck } from './ai/hooks/use-key-check';
export { BrandingSettings } from './branding/components/BrandingSettings';
export { CameraMascot } from './common/components/CameraMascot';
export { FaviconImg } from './common/components/FaviconImg';
+export { GitHubCard } from './common/components/GitHubCard';
export { MascotIcon } from './common/components/MascotIcon';
export { SavedBadge } from './common/components/SavedBadge';
export { Segmented } from './common/components/Segmented';
@@ -45,11 +46,11 @@ export { OnboardingFlow } from './onboarding/components/OnboardingFlow';
export { ProgressDots } from './onboarding/components/ProgressDots';
export { VoiceStep } from './onboarding/components/VoiceStep';
export type { StepProps } from './onboarding/types';
-export { SearchModal } from './search/components/SearchModal';
-export { useFullview } from './stores/use-fullview';
export { FinishButton } from './recording/components/FinishButton';
export { MicButton } from './recording/components/MicButton';
export { RecordingIconButton } from './recording/components/RecordingIconButton';
+export { SearchModal } from './search/components/SearchModal';
+export { useFullview } from './stores/use-fullview';
export { MicrophoneAccessRow } from './voice/components/MicrophoneAccessRow';
export { NarrationSettings } from './voice/components/NarrationSettings';
export { VoiceNotice } from './voice/components/VoiceNotice';