Este es uno de los repositorios que utilizamos en el curso Desarrollo de bots de Telegram en TypeScript, disponible en YouTube. Te recomendamos que mires el curso para entender un poco más sobre las tecnologías que elegimos. 😃
¡Bienvenida/o! En este repositorio encontrarás una plantilla (de las infinitas posibles) para crear un bot de Telegram utilizando NodeJS y TypeScript. Las principales tecnologías que utilizamos son:
- NodeJS: entorno de ejecución para JavaScript/TypeScript.
- grammY: framework para crear bots de Telegram.
- Jest: framework para escribir tests.
Para crear un proyecto siguiendo esta plantilla, lo único que tenés que hacer es clickear en el botón que dice Use this template. ¡Y no te olvides de cambiarle el nombre en el package.json!
Vas a necesitar un IDE o al menos un editor de texto que coloree la sintaxis. Recomendamos utilizar Visual Studio Code - que se lleva muy bien con proyectos TypeScript - enriquecido con los siguientes plugins:
Para ejecutar el código es necesario tener NodeJS en su versión 16 (lts/gallium). Para instalarlo recomendamos utilizar el manejador de versiones nvm, aunque también podés hacerlo manualmente siguiendo las instrucciones adecuadas para tu sistema operativo.
Asumiendo que ya configuraste todos los prerrequisitos, estos son los comandos que deberías ejecutar la primera vez que trabajes en el proyecto:
# Copia las variables de entorno necesarias para comunicarse con la Bot API de Telegram.
cp .env.example .env
# Instala las dependencias Node del proyecto.
npm install¡No te olvides de reemplazar el valor del BOT_TOKEN por el que te dio @BotFather.
A continuación, algunos comandos necesarios para el desarrollo diario en este proyecto.
# Levanta el proyecto y recarga automáticamente si hay cambios.
npm start
# Corre ESlint y Prettier, corrigiendo los errores que pueda y formateando el código.
npm run lint
# Ejecuta los tests una sola vez.
npm test
# Ejecuta los tests y se queda esperando por cambios.
npm test:watch