# messenja

> Framework for Telegram chatbots

Latest version **0.5.1** (published 2018-08-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install messenja
pnpm add messenja
yarn add messenja
bun add messenja
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.5.1 |
| Published | 2018-08-18 |
| First published | 2017-09-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 8.4 KB |
| Known vulnerabilities | 0 (+25 in 2 direct dependencies) |
| Install scripts | no |
| Author | Tim Izzo / 5ika |
| Maintainers | 5ika |
| Keywords | chatbots, telegram |

## Links

- npm: https://www.npmjs.com/package/messenja
- npm.io page: https://npm.io/package/messenja

## Dependencies (5)

- [koa](https://npm.io/package/koa.md) ^2.5.2
- [axios](https://npm.io/package/axios.md) ^0.18.0
- [redis](https://npm.io/package/redis.md) ^2.8.0
- [dotenv](https://npm.io/package/dotenv.md) ^6.0.0
- [koa-body](https://npm.io/package/koa-body.md) ^4.0.4

## Recent versions

- 0.5.1 (latest) — 2018-08-18
- 0.5.0 — 2018-08-12
- 0.4.0 — 2018-08-12
- 0.3.9 — 2018-05-20
- 0.3.8 — 2018-01-13
- 0.3.7 — 2017-11-25
- 0.3.6 — 2017-11-25
- 0.3.5 — 2017-11-12
- 0.3.4 — 2017-10-29
- 0.3.3 — 2017-10-29
- 0.3.2 — 2017-09-22
- 0.3.1 — 2017-09-22
- 0.3.0 — 2017-09-15

## README

# Messenja

Messenja est un framework NodeJS qui facilite la création de bots Telegram.

## Pré-requis

- Un serveur avec une URL en **https** accessible depuis le Web pour la communication avec l'API de Telegram
- Un token de bot Telegram [Voir ici](https://telegram.me/BotFather) avec une adresse de webhook configurée sur l'URL de votre serveur
- Une base de données Redis pour stocker des données entre les requêtes

## Installation

Messenja est disponible dans les dépôts NPM:

```bash
npm intall --save messenja
```

## Quick-start

```javascript
// index.js
const {Messenja} = require('messenja');

Messenja({request, response} => {
   const {first_name} = this.user;
   response.sendMessage(`Salut ${first_name} !`);
});
```

Avant de lancer votre bot, il est nécessaire de lui fournir des variables d'environnements:

```bash
export TELEGRAM_TOKEN=<token>
export REDIS_URL=redis
node index
```

## API

### Messenja

La fonction fourni à Messenja obtient trois arguments en retour (callback):

- `request` - Instance de `Request` pour l'utilisateur courant
- `response` - Instance de `Response` pour l'utilisateur courant
- `storage` - Utilitaire pour utiliser la base de données dans le contexte de l'utilisateur courant
- `data` - Ensemble des données de la base concernant l'utilisateur courant

---
_Source: https://npm.io/package/messenja · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._