228 lines
8.4 KiB
Markdown
228 lines
8.4 KiB
Markdown
<div align="center"><a name="readme-top"></a>
|
||
|
||
<img src="public/mascot.svg" width="140" height="140" alt="Mascote do Mimik" />
|
||
|
||
# Mimik
|
||
|
||
[English](./README.md) · [Español](./README.es.md) · **Português (BR)** · [Français](./README.fr.md)
|
||
|
||
**Captura qualquer fluxo no navegador e transforma num guia passo a passo. Sem conta, sem nuvem, sem rastreio.**
|
||
|
||
Clica em gravar, faz o que precisa, e recebe um guia caprichado com capturas de tela anotadas. Edita, reproduz ou exporta.
|
||
|
||
<!-- SHIELD GROUP -->
|
||
|
||
[![License][license-shield]][license-link]
|
||
[![Manifest V3][mv3-shield]][mv3-link]
|
||
[![100% Local][local-shield]][local-link]
|
||
[![No Account][no-account-shield]][no-account-link]
|
||
<br/>
|
||
[![Stars][star-shield]][star-link]
|
||
[![Contributors][contributors-shield]][contributors-link]
|
||
![Last Commit][last-commit-shield]
|
||
[![Issues][issues-shield]][issues-link]
|
||
|
||
</div>
|
||
|
||
<details>
|
||
<summary><kbd>Sumário</kbd></summary>
|
||
|
||
#### TOC
|
||
|
||
- [📺 Demo](#-demo)
|
||
- [👋 Começando](#-começando)
|
||
- [✨ Funcionalidades](#-funcionalidades)
|
||
- [🎬 Captura automática](#-captura-automática)
|
||
- [📸 Capturas anotadas](#-capturas-anotadas)
|
||
- [🔒 Smart Blur](#-smart-blur)
|
||
- [🧠 Descrições por IA (opcional)](#-descrições-por-ia-opcional)
|
||
- [▶️ Reprodução Guide Me](#️-reprodução-guide-me)
|
||
- [📤 Exportação multi-formato](#-exportação-multi-formato)
|
||
- [🌍 Multi-idioma](#-multi-idioma)
|
||
- [💾 Armazenamento 100% local](#-armazenamento-100-local)
|
||
- [🤝 Contribuir](#-contribuir)
|
||
- [📜 Licença](#-licença)
|
||
|
||
<br/>
|
||
|
||
</details>
|
||
|
||
## 📺 Demo
|
||
|
||
<div align="center">
|
||
<img src="public/demo.gif" alt="Demo do Mimik" width="800" />
|
||
</div>
|
||
|
||
## 👋 Começando
|
||
|
||
O Mimik transforma qualquer tarefa repetitiva do navegador num guia documentado e compartilhável em segundos. Roda inteiro dentro do teu navegador. Sem backend, sem conta, sem telemetria, e nada sai do teu dispositivo.
|
||
|
||
Seja documentando ferramentas internas, escrevendo tutoriais do produto, ou integrando um colega novo, o Mimik captura cada clique, tecla e navegação automaticamente pra tu focar no que importa.
|
||
|
||
| Navegador | Versão | Instalação |
|
||
| --------- | ------ | ---------- |
|
||
| Chrome | [![Chrome Version][chrome-version-shield]][chrome-link] | [Chrome Web Store][chrome-link] |
|
||
| Firefox | [![Firefox Version][firefox-version-shield]][firefox-link] | [Firefox Add-ons][firefox-link] |
|
||
|
||
> \[!IMPORTANT]
|
||
>
|
||
> **⭐️ Dá uma estrela no repo** se o Mimik te economiza tempo. Ajuda outras pessoas a descobrirem ele.
|
||
|
||
<a href="https://github.com/westpoint-io/mimik">
|
||
<img width="100%" alt="Dê uma estrela ao Mimik no GitHub" src="https://github.com/user-attachments/assets/80d304da-a765-4bde-bf49-b1bdcb4fe804" />
|
||
</a>
|
||
|
||
<div align="right">
|
||
|
||
[![Back to top][back-to-top]](#readme-top)
|
||
|
||
</div>
|
||
|
||
## ✨ Funcionalidades
|
||
|
||
### 🎬 Captura automática
|
||
|
||
Clica, digita, navega. O Mimik vê tudo. Cada ação relevante vira um passo: cliques em botões e links, campos de formulário, atalhos de teclado, área de transferência, arrastar e soltar, e navegações.
|
||
|
||
A fusão inteligente de eventos descarta os cliques rápidos em elementos próximos, pra teus guias ficarem limpos. A interceptação do clique acontece *antes* da página mudar, então nada se perde em SPAs nem em recarregamentos completos.
|
||
|
||
<div align="right">
|
||
|
||
[![Back to top][back-to-top]](#readme-top)
|
||
|
||
</div>
|
||
|
||
### 📸 Capturas anotadas
|
||
|
||
Cada passo ganha uma captura com o elemento clicado destacado e um zoom na área importante. Sem recortar na mão, sem aprender ferramentas de anotação. O Mimik descobre qual parte da página importa e enquadra ela pra ti.
|
||
|
||
<div align="right">
|
||
|
||
[![Back to top][back-to-top]](#readme-top)
|
||
|
||
</div>
|
||
|
||
### 🔒 Smart Blur
|
||
|
||
O Mimik detecta e desfoca dados sensíveis automaticamente nas tuas capturas: e-mails, telefones, CPFs, cartões de crédito, IPs, endereços MAC. Liga ou desliga cada categoria do jeito que tu quiser.
|
||
|
||
Precisa esconder algo específico? O seletor manual deixa tu escolher qualquer elemento do DOM e mascarar ele em todas as capturas onde aparecer.
|
||
|
||
<div align="right">
|
||
|
||
[![Back to top][back-to-top]](#readme-top)
|
||
|
||
</div>
|
||
|
||
### 🧠 Descrições por IA (opcional)
|
||
|
||
Traz a tua API key (OpenAI ou Anthropic) e o Mimik gera descrições naturais tipo *"Clique no botão **Enviar** pra salvar as alterações"* ao invés de `Click button "Submit"`.
|
||
|
||
As descrições são geradas a partir de um contexto leve do DOM (~50-100 tokens), não das capturas. Umas 15-30 vezes mais barato que modelos com visão. Escolhe o idioma das descrições (inglês, espanhol, português, francês).
|
||
|
||
<div align="right">
|
||
|
||
[![Back to top][back-to-top]](#readme-top)
|
||
|
||
</div>
|
||
|
||
### ▶️ Reprodução Guide Me
|
||
|
||
Reproduz qualquer guia ao vivo numa página real. O Mimik destaca o próximo elemento, marca teu progresso passo a passo, e avança sozinho conforme tu vai interagindo. Perfeito pra integrar colegas ou pra se guiar num processo tu mesmo.
|
||
|
||
<div align="right">
|
||
|
||
[![Back to top][back-to-top]](#readme-top)
|
||
|
||
</div>
|
||
|
||
### 📤 Exportação multi-formato
|
||
|
||
Compartilha os guias no formato que melhor cabe no teu fluxo:
|
||
|
||
- **HTML**: autônomo, compartilha em qualquer lugar, imagens embutidas em base64
|
||
- **PDF**: pronto pra imprimir, A4 retrato com quebras de página automáticas
|
||
- **Markdown**: cola no Notion, GitHub, docs internas, wikis
|
||
|
||
Todas as exportações são geradas no cliente. Nada passa por servidor.
|
||
|
||
<div align="right">
|
||
|
||
[![Back to top][back-to-top]](#readme-top)
|
||
|
||
</div>
|
||
|
||
### 🌍 Multi-idioma
|
||
|
||
Interface disponível em inglês, espanhol, português brasileiro e francês. O idioma das descrições de IA é configurado separadamente, então tu pode usar o Mimik em inglês e gerar os guias em português, ou qualquer combinação.
|
||
|
||
<div align="right">
|
||
|
||
[![Back to top][back-to-top]](#readme-top)
|
||
|
||
</div>
|
||
|
||
### 💾 Armazenamento 100% local
|
||
|
||
Teus guias, passos e capturas ficam no teu dispositivo. Sem backend, sem conta, sem telemetria. Tuas API keys (se tu usar alguma) nunca saem do navegador. Ficam salvas localmente e vão direto pro provedor de IA que tu escolheu.
|
||
|
||
<div align="right">
|
||
|
||
[![Back to top][back-to-top]](#readme-top)
|
||
|
||
</div>
|
||
|
||
## 🤝 Contribuir
|
||
|
||
Todo tipo de contribuição é bem-vinda: relatos de bug, ideias novas, PRs e traduções.
|
||
|
||
Olha o [CONTRIBUTING.md](./CONTRIBUTING.md) pro setup de dev, a estrutura do projeto, e as diretrizes pra contribuidores.
|
||
|
||
<div align="right">
|
||
|
||
[![Back to top][back-to-top]](#readme-top)
|
||
|
||
</div>
|
||
|
||
## 📜 Licença
|
||
|
||
MIT © [Westpoint](https://github.com/westpoint-io). Olha o [LICENSE](./LICENSE) pros detalhes.
|
||
|
||
<div align="right">
|
||
|
||
[![Back to top][back-to-top]](#readme-top)
|
||
|
||
</div>
|
||
|
||
<!-- LINK GROUP -->
|
||
|
||
[back-to-top]: https://img.shields.io/badge/-BACK_TO_TOP-1E1B4B?style=flat-square
|
||
|
||
[license-shield]: https://img.shields.io/badge/license-MIT-4F46E5?style=flat-square&labelColor=1E1B4B
|
||
[license-link]: ./LICENSE
|
||
|
||
[mv3-shield]: https://img.shields.io/badge/manifest-v3-3730A3?style=flat-square&labelColor=1E1B4B
|
||
[mv3-link]: https://developer.chrome.com/docs/extensions/mv3/intro/
|
||
|
||
[local-shield]: https://img.shields.io/badge/storage-100%25%20local-4F46E5?style=flat-square&labelColor=1E1B4B
|
||
[local-link]: #-armazenamento-100-local
|
||
|
||
[no-account-shield]: https://img.shields.io/badge/account-not%20required-4F46E5?style=flat-square&labelColor=1E1B4B
|
||
[no-account-link]: #-armazenamento-100-local
|
||
|
||
[star-shield]: https://img.shields.io/github/stars/westpoint-io/mimik?style=flat-square&label=stars&color=4F46E5&labelColor=1E1B4B
|
||
[star-link]: https://github.com/westpoint-io/mimik/stargazers
|
||
|
||
[contributors-shield]: https://img.shields.io/github/contributors/westpoint-io/mimik?style=flat-square&labelColor=1E1B4B
|
||
[contributors-link]: https://github.com/westpoint-io/mimik/graphs/contributors
|
||
|
||
[last-commit-shield]: https://img.shields.io/github/last-commit/westpoint-io/mimik?style=flat-square&label=commit&labelColor=1E1B4B
|
||
|
||
[issues-shield]: https://img.shields.io/github/issues/westpoint-io/mimik?style=flat-square&labelColor=1E1B4B
|
||
[issues-link]: https://github.com/westpoint-io/mimik/issues
|
||
|
||
[chrome-version-shield]: https://img.shields.io/chrome-web-store/v/jmfohdaflahliammccpiadmkcibohgha?label=Chrome%20Version&style=flat-square&logo=googlechrome&logoColor=C7D2FE&color=4F46E5&labelColor=1E1B4B
|
||
[chrome-link]: https://chromewebstore.google.com/detail/mimik/jmfohdaflahliammccpiadmkcibohgha
|
||
[firefox-version-shield]: https://img.shields.io/amo/v/mimik?label=Firefox%20Version&style=flat-square&logo=firefoxbrowser&logoColor=C7D2FE&color=4F46E5&labelColor=1E1B4B
|
||
[firefox-link]: https://addons.mozilla.org/en-US/firefox/addon/mimik/
|