# feathers-telegram-bot

> Connect your feathers app to a Telegram Bot

Latest version **0.0.1-2** (published 2017-09-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install feathers-telegram-bot
pnpm add feathers-telegram-bot
yarn add feathers-telegram-bot
bun add feathers-telegram-bot
```

## 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.0.1-2 |
| Published | 2017-09-25 |
| First published | 2017-09-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 6.0.0 |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Feathers contributors |
| Maintainers | miguelpeixe |
| Keywords | feathers, feathers-plugin |

## Links

- npm: https://www.npmjs.com/package/feathers-telegram-bot
- Repository: https://github.com/aparabolica/feathers-telegram-bot
- Issues: https://github.com/aparabolica/feathers-telegram-bot/issues
- npm.io page: https://npm.io/package/feathers-telegram-bot

## Dependencies (4)

- [lodash.omit](https://npm.io/package/lodash.omit.md) ^4.5.0
- [lodash.union](https://npm.io/package/lodash.union.md) ^4.6.0
- [feathers-errors](https://npm.io/package/feathers-errors.md) ^2.9.2
- [node-telegram-bot-api](https://npm.io/package/node-telegram-bot-api.md) ^0.28.0

## Alternatives

- [@fortawesome/react-fontawesome](https://npm.io/package/@fortawesome/react-fontawesome.md) — 2.2M weekly downloads
- [roboto-fontface](https://npm.io/package/roboto-fontface.md) — 196.0K weekly downloads
- [@react-native-vector-icons/common](https://npm.io/package/@react-native-vector-icons/common.md) — 150.4K weekly downloads
- [@procore/core-icons](https://npm.io/package/@procore/core-icons.md) — 4.6K weekly downloads
- [@react-md/material-icons](https://npm.io/package/@react-md/material-icons.md) — 1.6K weekly downloads

## Recent versions

- 0.0.1-2 (latest) — 2017-09-25
- 0.0.1-6 (pre) — 2017-09-25
- 0.0.1-5 — 2017-09-25
- 0.0.1-4 — 2017-09-25
- 0.0.1-3 — 2017-09-25

## README

# Feathers Telegram Bot

[![Build Status](https://travis-ci.org/aparabolica/feathers-telegram-bot.png?branch=master)](https://travis-ci.org/aparabolica/feathers-telegram-bot)
[![Code Climate](https://codeclimate.com/github/aparabolica/feathers-telegram-bot/badges/gpa.svg)](https://codeclimate.com/github/aparabolica/feathers-telegram-bot)
[![Test Coverage](https://codeclimate.com/github/aparabolica/feathers-telegram-bot/badges/coverage.svg)](https://codeclimate.com/github/aparabolica/feathers-telegram-bot/coverage)
[![Dependency Status](https://img.shields.io/david/aparabolica/feathers-telegram-bot.svg?style=flat-square)](https://david-dm.org/aparabolica/feathers-telegram-bot)
[![Download Status](https://img.shields.io/npm/dm/feathers-telegram-bot.svg?style=flat-square)](https://www.npmjs.com/package/feathers-telegram-bot)

> Connect your feathers app to a Telegram Bot

## Installation

```
npm install feathers-telegram-bot --save
```

## Documentation

Under construction.

## Complete Example

Here's an example of a Feathers server that uses `feathers-telegram-bot`.

```js
const feathers = require('feathers');
const rest = require('feathers-rest');
const hooks = require('feathers-hooks');
const bodyParser = require('body-parser');
const errorHandler = require('feathers-errors/handler');
const telegramBot = require('feathers-telegram-bot');

// Initialize the application
const app = feathers()
  .configure(rest())
  .configure(hooks())
  // Needed for parsing bodies (login)
  .use(bodyParser.json())
  .use(bodyParser.urlencoded({ extended: true }))
  // Initialize your feathers plugin
  .use(telegramBot({
    username: "Your_Bot",
    token: "[your-token-here]"
  }))
  .use(errorHandler());

app.listen(3030);

console.log('Feathers app started on 127.0.0.1:3030');
```

## License

Copyright (c) 2017

Licensed under the [MIT license](LICENSE).

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