Skip to content
This repository has been archived by the owner on Jul 12, 2023. It is now read-only.

AkiraTorres/Status-Cat

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Status Cat

banner

Sobre


Esse bot foi desenvolvido com o objetivo de ser utilizado para uma consulta rápida para desenvolvedores e outras pessoas que estudam/trabalham na área de tecnologia, com o para facilitar a vida e pesquisas, ou ao menos ser uma opção a mais para essas pessoas.

Índice

SobreÍndiceFeaturesInstalaçãoAutorLicença Créditos

Features


O bot ainda está em desenvolvimento e ideas para features novas podem acontecer a qualquer momento, aqui está uma lista delas, que vai sendo marcada conforme forem sendo feitas.

  • Exibir uma breve descrição de um código HTTP específico quando usado o comando com um argumento.
  • Quando o bot não conseguir uma imagem no http.cat fazer ele retornar ainda assim uma mensagem explicando o código HTTP.
  • Retornar um link ou pdf com a documentação da linguagem/framework pesquisado.

Instalação


Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js e Yarn.
Além disto é bom ter um editor para trabalhar com o código como VSCode ou o Atom.
Também será necessário que você já tenha criado o bot e adquirido o token da API do Telegram através do BotFather.

Executando o Bot

Clone este repositório

$ git clone <https://github.com/akiratorres/status-cat>

Acesse a pasta do projeto no terminal

$ cd status-cat

Vá para a pasta src

$ cd src

Instale as dependências

$ yarn install

Antes de executar o bot, crie o arquivo .env seguindo o .env.example e e garanta que as chaves necessárias estão corretamente preenchidas.

Execute a aplicação em modo de desenvolvimento

$ yarn dev

A partir daí a aplicação começará a ser executada no bot que você criou no Telegram.

banner

Autor



Thiago Torres

Feito por motivos educacionais, para se aprimorar na linguagem e framework utilizados.

Twitter Badge Gmail Badge

Licença


Este projeto esta sobe a licença MIT.

Créditos


  • Um agradecimento especial para http.cat, boa parte do projeto perderia o charme sem as imagens, e foi graças a esse site que eu tive inspiração para fazer o bot.
  • As informações sobre os códigos HTTP foram retiradas dos sites MDN Web Docs e Wikipedia.