Quick Translation

---

DEMONSTRAÇÃO DE USO 🡾

---

Sumário

• 🎯 Objetivo
• 🚀 Principais recursos
• ⬇️ Como instalar
• 💻 Como usar
• 🔑 DeepL API Key
• ⌨️ Atalhos
• 👨‍💻 Modo DEV
  • 📋 Listas com os tipos de formatações
    • CSharp
    • JavaScript
    • Python
• 🔧 Pré-requisitos
• ⚙️ Como executar o projeto
• 🛠️ Tecnologias utilizadas
• 📜 Licença
• 📝 Autor

---

🎯 Objetivo

O Quick Translation redefine a experiência de tradução de texto, tornando-a prática e rápida.

Desenvolvido para facilitar o aprendizado de novos idiomas para qualquer pessoa interessada, o aplicativo oferece um modo DEV (desenvolvedor) especialmente projetado para desenvolvedores que desejam aprimorar seus códigos e aumentar sua fluência em um idioma específico de forma produtiva.

---

🚀 Principais recursos

• Praticidade na tradução: sempre à disposição durante suas tarefas com um simple clique ou atalho;
• Interface intuitiva: fácil de usar para usuários de todos os níveis;
• Sobreposição: praticidade na utilização com a possibilidade de fixar na frente de outros aplicativos;
• Área de transferência automática: cópia da tradução salva automaticamente na área de transferência para utilização em outros aplicativos;
• Modo DEV: tradução de nomes de variaveis, métodos, classes e muito mais com formatação para a sintaxe de uma linguagem de programação, simplificando a codificação.

---

⬇️ Como instalar

Para instalar o aplicativo em seu computador siga as seguintes instruções:

1. No lado direito, dentro da seção Releases, clique na versão mais recente disponível (atualmente v0.9.0-beta.3).
   • Para instalar versões anteriores clique em Releases e selecione a versão que desejar.
2. Clique no arquivo executável (.exe) para baixá-lo.
   • Caso não encontre o arquivo clique aqui para baixá-lo automaticamente.
3. Após baixado, navegue até o diretório onde o arquivo foi salvo (geralmente no diretório Downloads) e clique duas vezes sobre o arquivo.
4. O aplicativo será instalado automaticamente e, após a conclusão, será executado e estará pronto para a utilização.
   • Caso o Windows mostre uma mensagem de proteção, clique em More info e, em seguida, clique em Run anyway para permitir a execução do aplicativo.
   • Caso não execute automaticamente, procure por Quick Translation na barra de pesquisa do Windows e clique sobre o aplicativo.

Observação: alguns textos podem variar dependendo do idioma configurado em seu computador.

💻 Como usar

Para usar o aplicativo siga as seguintes etapas:

1. Clique no ícone de expandir ou use o atalho Ctrl + T para maximizar o aplicativo, se estiver minimizado.
   • É possivel deixá-lo sempre maximizado clicando no ícone de alfinete.
2. Escolha os idiomas de origem e destino para a tradução.
3. Digite o texto que você deseja traduzir no campo apropriado.
   • É possivel inverter a tradução digitando o texto no campo do idioma de destino.
   • Se desejar usar o modo DEV, clique no ícone de engrenagem e, em seguida, selecionar o destino da formatação entre as linguagens de programação disponíveis.
4. Após digitar o texto, pressione a tecla Enter.

Pronto! O texto traduzido será copiado automaticamente para sua área de transferência. Agora você pode colar onde desejar.

---

🔑 DeepL API Key

As traduções são feitas pela API DeepL. Para usar o aplicativo, é necessário configurar uma API Key.

Como obter e configurar:

1. Acesse deepl.com/pro-api e crie uma conta (há plano gratuito).
2. Gere uma API Key na área da sua conta.
3. No Quick Translation, clique no ícone de engrenagem (Settings).
4. Cole sua API Key no campo DeepL API Key e clique em Save API Key.

Idiomas suportados: Inglês (EN), Português do Brasil (PT-BR), Espanhol (ES), Japonês (JA) e Coreano (KO).

Se a API Key não estiver configurada, ao tentar traduzir será exibida a mensagem API key not found na parte inferior da tela.

---

⌨️ Atalhos

Teclas	Evento
Tab	Navega entre os campos e botões do aplicativo
Enter	Nos campos de texto realiza a tradução e nos demais campos realiza a ação de clique
Ctrl + T	Maximiza ou minimiza o aplicativo
Alt + Tab	Navega entre aplicativos (retorna ao ponto anterior do cursor após a tradução)

---

👨‍💻 Modo DEV

Habilite o modo DEV digitando . (ponto) antes do texto para traduzir e o tipo de formatação como mostra no exemplo a seguir:

Entrada ➔ PT-BR (CSharp)

.ms obter todos os usuários 

Saída ➔ EN-CA (CSharp)

public string GetAllUsers()
{
	return ;
}

Observação: após o tipo de formatação é necessário dar um espaço para digitar o texto.

📋 Listas com os tipos de formatações:

CSharp

Tipo de formatação	Sintaxe de saída	Exemplo de saída (EN-CA)
..	Apenas o texto na sintaxe de uma variável	translatedText
.c	Classe (público)	public class TranslatedText { }
.e	Enumeração (público)	public enum TranslatedText { }
.i	Interface (público)	public interface ITranslatedText { }
.m ou .mv	Método do tipo void (público)	public void TranslatedText() { return ; }
.mb	Método do tipo bool (público)	public bool TranslatedText() { return ; }
.mc	Método do tipo char (público)	public char TranslatedText() { return ; }
.md	Método do tipo double (público)	public double TranslatedText() { return ; }
.mf	Método do tipo float (público)	public float TranslatedText() { return ; }
.mi	Método do tipo int (público)	public int TranslatedText() { return ; }
.ms	Método do tipo string (público)	public tipo TranslatedText() { return ; }
.p ou .ps	Propriedade do tipo string	public string TranslatedText { get; set; }
.pb	Propriedade do tipo bool	public bool TranslatedText { get; set; }
.pc	Propriedade do tipo char	public char TranslatedText { get; set; }
.pd	Propriedade do tipo double	public double TranslatedText { get; set; }
.pf	Propriedade do tipo float	public float TranslatedText { get; set; }
.pi	Propriedade do tipo int	public int TranslatedText { get; set; }
.v ou .vs	Variável do tipo string	string translatedText = ;
.vb	Variável do tipo bool	bool translatedText = ;
.vc	Variável do tipo char	char translatedText = ;
.vd	Variável do tipo double	double translatedText = ;
.vf	Variável do tipo float	float translatedText = ;
.vi	Variável do tipo int	int translatedText = ;

JavaScript

Tipo de formatação	Sintaxe de saída	Exemplo de saída (EN-CA)
..	Apenas o texto na sintaxe de uma variável	translatedText
.c	Classe	class TranslatedText { }
.f	Método sem retorno	function translatedText() { }
.f(qualquer_caractere)	Método com retorno	function translatedText() { return ; }
.v	Variável	var translatedText = ;

Python

Tipo de formatação	Sintaxe de saída	Exemplo de saída (EN-CA)
..	Apenas o texto na sintaxe de uma variável	translated_text
.c	Classe	class TranslatedText:
.f	Método sem retorno	def translated_text():
.f(qualquer_caractere)	Método com retorno	def translated_text(): return
.v	Variável	translated_text =

---

🔧 Pré-requisitos

• Sistema operacional Windows;
• Conexão com internet.

---

⚙️ Como executar o projeto

Execute o Quick Translation em sua máquina local com os seguintes passos:

1. Instale o Node.js em sua máquina.
   • Disponível em: https://nodejs.org/en.
2. Clone o projeto para o diretório que desejar executando o seguinte comando via terminal:

git clone https://github.com/luishperna/electron-quick-translation.git

3. Instale as dependências do projeto usando o comando:

npm install

4. Execute o projeto com o comando abaixo:

npm run dev

O projeto será executado e estará pronto para realizar testes e/ou receber alterações em seu código-fonte.

🛠️ Tecnologias utilizadas

• HTML CSS JavaScript Electron Electron-builder DeepL API

---

📜 Licença

MIT License

Copyright (c) 2023 Luís Henrique Perna

---

📝 Autor

Luís Henrique Perna