https://github.com/plzbugmenot/tg-bot-init
This repository contains the initial setup for a Telegram bot developed using Node.js and TypeScript. The bot is currently in development and not yet ready for production use.
https://github.com/plzbugmenot/tg-bot-init
node-js npm telegram-bot telegram-bot-api typescript
Last synced: 3 months ago
JSON representation
This repository contains the initial setup for a Telegram bot developed using Node.js and TypeScript. The bot is currently in development and not yet ready for production use.
- Host: GitHub
- URL: https://github.com/plzbugmenot/tg-bot-init
- Owner: plzbugmenot
- License: gpl-3.0
- Created: 2024-10-27T04:35:09.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-10-27T04:37:37.000Z (7 months ago)
- Last Synced: 2025-01-07T06:56:25.578Z (5 months ago)
- Topics: node-js, npm, telegram-bot, telegram-bot-api, typescript
- Language: TypeScript
- Homepage:
- Size: 17.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# [Telegram Bot](https://github.com/acmicpc0614/TG-bot-init.git)
A Telegram Bot using Node.js in typescript ✨
## 📡 Quick Start
> If you are new to Telegram bots, read the official [Introduction for Developers](https://core.telegram.org/bots) written by the Telegram team.
>
> **_Warning_**: This BOT is not yet ready for production. It is still in development. 🚧
>
> ### Requirements:
>
> - [TypeScript v4](https://www.typescriptlang.org/docs/handbook/typescript-in-5-minutes.html)
> - [Node.js v18](https://nodejs.org/)
> - Atleast 1vCPU , 512MB RAM and 40GB Storage.
### Steps:
- `Star⭐` this Repo to get updates.
- Create a bot from [@BotFather](https://t.me/BotFather) and get the access token.
- Clone this Repo:
```bash
git clone https://github.com/acmicpc0614/TG-bot-init.git
```
- Install all dependencies and devDependencies:
using [yarn](https://yarnpkg.com/) package manager:
```bash
yarn add
```
Or using [npm](https://www.npmjs.com/) package manager:
```bash
npm install
```
- Rename the `.env.example` file to `.env` and fill it with access token.
- Start the `Bot` in `Production`:
using [yarn](https://yarnpkg.com/) package manager:
```bash
yarn start
```
Or using [npm](https://www.npmjs.com/) package manager:
```bash
npm start
```
Or, Start the `Bot` in `Development environment`:
using [yarn](https://yarnpkg.com/) package manager:
```bash
yarn dev
```
Or using [npm](https://www.npmjs.com/) package manager:
```bash
npm run dev
```
- Use the BOT 🎉