From 59b1862129d4660c70ba2836bf0e918e6d96461a Mon Sep 17 00:00:00 2001 From: Rogerio Munhoz Date: Thu, 10 Aug 2023 09:58:46 -0300 Subject: [PATCH 1/4] feat: translate guide/getting-started --- site/docs/pt/guide/getting-started.md | 222 ++++++++++++++++++++++++++ 1 file changed, 222 insertions(+) create mode 100644 site/docs/pt/guide/getting-started.md diff --git a/site/docs/pt/guide/getting-started.md b/site/docs/pt/guide/getting-started.md new file mode 100644 index 000000000..538422e47 --- /dev/null +++ b/site/docs/pt/guide/getting-started.md @@ -0,0 +1,222 @@ +# Primeiros Passos + +Crie seu primeiro Bot em minutos. ([Desça um pouco](#getting-started-on-deno) para um guia para um projeto Deno.) + +## Primeiros passos no Node.js + +> Esse guia assume que você tem o [Node.js](https://nodejs.org) instalado, e o `npm` deve vir com ele. +> Se você não sabe o que são essas coisas, dê uma olhada na nossa [Introdução](./introduction)! + +Crie um novo projeto TypeScript e instale o pacote `grammy`. +Para fazer isso, abra um terminal e digite: + +::: code-group + +```sh [npm] +# Crie um novo diretório e entre nele. +mkdir meu-bot +cd meu-bot + +# Configure o TypeScript (ignore esse passo se você usa JavaScript). +npm install -D typescript +npx tsc --init + +# Instale o grammY. +npm install grammy +``` + +```sh [Yarn] +# Crie um novo diretório e entre nele. +mkdir meu-bot +cd meu-bot + +# Configure o TypeScript (ignore esse passo se você usa JavaScript). +yarn add typescript -D +npx tsc --init + +# Instale o grammY. +yarn add grammy +``` + +```sh [pnpm] +# Crie um novo diretório e entre nele. +mkdir meu-bot +cd meu-bot + +# Configure o TypeScript (ignore esse passo se você usa JavaScript). +pnpm add -D typescript +npx tsc --init + +# Instale o grammY. +pnpm add grammy +``` + +::: + +Crie um novo arquivo de texto vazio chamado `bot.ts`, por exemplo. +Sua estrutura de diretórios deve ficar mais ou menos assim: + +```asciiart:no-line-numbers +. +├── bot.ts +├── node_modules/ +├── package.json +├── package-lock.json +└── tsconfig.json +``` + +Agora, é hora de abrir o Telegram para criar uma conta de bot e obter um token de bot para ele. +Fale com o [@BotFather](https://t.me/BotFather) para fazer isso. +O token do bot é algo como `123456:aBcDeF_gHiJkLmNoP-q`. +Ele é usado para autenticar seu bot. + +Pegou o token? Agora você pode escrever o código do seu bot no arquivo `bot.ts`. +Você pode copiar o seguinte bot de exemplo para esse arquivo, e passar seu token para o construtor `Bot`: + +::: code-group + +```ts [TypeScript] +import { Bot } from "grammy"; + +// Crie uma instância da classe `Bot` e passe seu token de bot para ela. +const bot = new Bot(""); // <-- coloque o token do seu bot entre "" + +// Agora você pode registrar listeners no objeto `bot`. +// O grammY irá chamar os listeners quando usuários enviarem mensagens para seu bot. + +// Trata o comando /start. +bot.command("start", (ctx) => ctx.reply("Boas vindas! Online e roteando 😎")); +// Trata outras mensagens. +bot.on("message", (ctx) => ctx.reply("Chegou outra mensagem!")); + +// Agora que você especificou como tratar mensagens, você pode iniciar seu bot. +// Isso irá conectar aos servidores do Telegram e esperar por mensagens. + +// Inicia o bot. +bot.start(); +``` + +```js [JavaScript] +const { Bot } = require("grammy"); + +// Crie uma instância da classe `Bot` e passe seu token de bot para ela. +const bot = new Bot(""); // <-- coloque o token do seu bot entre "" + +// Agora você pode registrar listeners no objeto `bot`. +// O grammY irá chamar os listeners quando usuários enviarem mensagens para seu bot. + +// Trata o comando /start. +bot.command("start", (ctx) => ctx.reply("Boas vindas! Online e roteando :sunglasses:")); +// Trata outras mensagens. +bot.on("message", (ctx) => ctx.reply("Chegou outra mensagem!")); + +// Agora que você especificou como tratar mensagens, você pode iniciar seu bot. +// Isso irá conectar aos servidores do Telegram e esperar por mensagens. + +// Inicia o bot. +bot.start(); +``` + +::: + +Para compilar o código, execute + +```sh +npx tsc +``` + +no seu terminal. +Isso gera o arquivo JavaScript `bot.js`. + +Agora é só executar o bot rodando o comando + +```sh +node bot.js +``` + +no terminal. +E pronto! :tada: + +Vá para o Telegram para ver seu bot responder às mensagens! + +::: tip Habilitando Logs +Para habilitar alguns logs básicos, execute + +```sh +export DEBUG="grammy*" +``` + +no seu terminal antes de executar `node bot.js`. +Vai ser mais fácil debugar o seu bot assim. +::: + +## Primeiros passos no Deno + +> Esse guia assume que você tem o [Deno](https://deno.land) instalado. + +Crie um novo diretório em algum lugar, e crie um novo arquivo de texto vazio nele, chamado `bot.ts` por exemplo. + +```sh +mkdir ./meu-bot +cd ./meu-bot +touch bot.ts +``` + +Agora, é hora de abrir o Telegram para criar uma conta de bot e obter um token de bot para ele. +Fale com o [@BotFather](https://t.me/BotFather) para fazer isso. +O token do bot é algo como `123456:aBcDeF_gHiJkLmNoP-q`. +Ele é usado para autenticar seu bot. + +Pegou o token? Agora você pode escrever o código do seu bot no arquivo `bot.ts`. +Você pode copiar o seguinte bot de exemplo para esse arquivo, e passar seu token para o construtor `Bot`: + +```ts +import { Bot } from "https://deno.land/x/grammy/mod.ts"; + +// Crie uma instância da classe `Bot` e passe seu token de bot para ela. +const bot = new Bot(""); // <-- coloque o token do seu bot entre "" + +// Agora você pode registrar listeners no objeto `bot`. +// O grammY irá chamar os listeners quando usuários enviarem mensagens para seu bot. + +// Trata o comando /start. +bot.command("start", (ctx) => ctx.reply("Boas vindas! Online e roteando 😎")); +// Trata outras mensagens. +bot.on("message", (ctx) => ctx.reply("Chegou outra mensagem!")); + +// Agora que você especificou como tratar mensagens, você pode iniciar seu bot. +// Isso irá conectar aos servidores do Telegram e esperar por mensagens. + +// Inicia o bot. +bot.start(); +``` + +Agora é só executar o bot rodando o comando + +```sh +deno run --allow-net bot.ts +``` + +no terminal. +E pronto! :tada: + +Vá para o Telegram para ver seu bot responder às mensagens! + +::: tip Habilitando Logs +Para habilitar alguns logs básicos, execute + +```sh +export DEBUG="grammy*" +``` + +no seu terminal antes de executar seu bot. +Vai ser mais fácil debugar o seu bot assim. + +Além disso, você precisa executar o bot usando + +```sh +deno run --allow-net --allow-env bot.ts +``` + +para que o grammY consiga ler a variável de ambiente `DEBUG`. +::: From ee9c72c88e0d42dbbcbfa4a7cf0d0c3b9c7060b8 Mon Sep 17 00:00:00 2001 From: Roz <3948961+roziscoding@users.noreply.github.com> Date: Thu, 10 Aug 2023 18:01:28 -0300 Subject: [PATCH 2/4] Apply suggestions from code review Co-authored-by: Kratos --- site/docs/pt/guide/getting-started.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/site/docs/pt/guide/getting-started.md b/site/docs/pt/guide/getting-started.md index 538422e47..59301dbfe 100644 --- a/site/docs/pt/guide/getting-started.md +++ b/site/docs/pt/guide/getting-started.md @@ -65,13 +65,13 @@ Sua estrutura de diretórios deve ficar mais ou menos assim: └── tsconfig.json ``` -Agora, é hora de abrir o Telegram para criar uma conta de bot e obter um token de bot para ele. +Agora, é hora de abrir o Telegram para criar um bot e obter um token para ele. Fale com o [@BotFather](https://t.me/BotFather) para fazer isso. O token do bot é algo como `123456:aBcDeF_gHiJkLmNoP-q`. Ele é usado para autenticar seu bot. Pegou o token? Agora você pode escrever o código do seu bot no arquivo `bot.ts`. -Você pode copiar o seguinte bot de exemplo para esse arquivo, e passar seu token para o construtor `Bot`: +Copie o seguinte bot de exemplo para esse arquivo, e passar seu token para o construtor `Bot`: ::: code-group @@ -85,7 +85,7 @@ const bot = new Bot(""); // <-- coloque o token do seu bot entre "" // O grammY irá chamar os listeners quando usuários enviarem mensagens para seu bot. // Trata o comando /start. -bot.command("start", (ctx) => ctx.reply("Boas vindas! Online e roteando 😎")); +bot.command("start", (ctx) => ctx.reply("Boas vindas! Online e roteando :sunglasses:")); // Trata outras mensagens. bot.on("message", (ctx) => ctx.reply("Chegou outra mensagem!")); @@ -162,13 +162,13 @@ cd ./meu-bot touch bot.ts ``` -Agora, é hora de abrir o Telegram para criar uma conta de bot e obter um token de bot para ele. +Agora, é hora de abrir o Telegram para criar um bot e obter um token para ele. Fale com o [@BotFather](https://t.me/BotFather) para fazer isso. O token do bot é algo como `123456:aBcDeF_gHiJkLmNoP-q`. Ele é usado para autenticar seu bot. Pegou o token? Agora você pode escrever o código do seu bot no arquivo `bot.ts`. -Você pode copiar o seguinte bot de exemplo para esse arquivo, e passar seu token para o construtor `Bot`: +Copie o seguinte bot de exemplo para esse arquivo, e passar seu token para o construtor `Bot`: ```ts import { Bot } from "https://deno.land/x/grammy/mod.ts"; From adfbbb847f782d592535f4fdcc520e60e9237454 Mon Sep 17 00:00:00 2001 From: Roz <3948961+roziscoding@users.noreply.github.com> Date: Thu, 10 Aug 2023 18:51:02 -0300 Subject: [PATCH 3/4] Apply suggestions from code review --- site/docs/pt/guide/getting-started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/docs/pt/guide/getting-started.md b/site/docs/pt/guide/getting-started.md index 59301dbfe..636c28e97 100644 --- a/site/docs/pt/guide/getting-started.md +++ b/site/docs/pt/guide/getting-started.md @@ -180,7 +180,7 @@ const bot = new Bot(""); // <-- coloque o token do seu bot entre "" // O grammY irá chamar os listeners quando usuários enviarem mensagens para seu bot. // Trata o comando /start. -bot.command("start", (ctx) => ctx.reply("Boas vindas! Online e roteando 😎")); +bot.command("start", (ctx) => ctx.reply("Boas vindas! Online e roteando :sunglasses:")); // Trata outras mensagens. bot.on("message", (ctx) => ctx.reply("Chegou outra mensagem!")); From e56e971b776907cc403fba532a441d612149d6c6 Mon Sep 17 00:00:00 2001 From: Roz <3948961+roziscoding@users.noreply.github.com> Date: Thu, 10 Aug 2023 18:59:06 -0300 Subject: [PATCH 4/4] Apply suggestions from code review --- site/docs/pt/guide/getting-started.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/site/docs/pt/guide/getting-started.md b/site/docs/pt/guide/getting-started.md index 636c28e97..8b8b33344 100644 --- a/site/docs/pt/guide/getting-started.md +++ b/site/docs/pt/guide/getting-started.md @@ -85,7 +85,7 @@ const bot = new Bot(""); // <-- coloque o token do seu bot entre "" // O grammY irá chamar os listeners quando usuários enviarem mensagens para seu bot. // Trata o comando /start. -bot.command("start", (ctx) => ctx.reply("Boas vindas! Online e roteando :sunglasses:")); +bot.command("start", (ctx) => ctx.reply("Online e roteando! :sunglasses:")); // Trata outras mensagens. bot.on("message", (ctx) => ctx.reply("Chegou outra mensagem!")); @@ -180,7 +180,7 @@ const bot = new Bot(""); // <-- coloque o token do seu bot entre "" // O grammY irá chamar os listeners quando usuários enviarem mensagens para seu bot. // Trata o comando /start. -bot.command("start", (ctx) => ctx.reply("Boas vindas! Online e roteando :sunglasses:")); +bot.command("start", (ctx) => ctx.reply("Online e roteando! :sunglasses:")); // Trata outras mensagens. bot.on("message", (ctx) => ctx.reply("Chegou outra mensagem!"));