Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/philmod/url-shortener-bot

Messenger bot to shorten urls
https://github.com/philmod/url-shortener-bot

Last synced: about 1 month ago
JSON representation

Messenger bot to shorten urls

Awesome Lists containing this project

README

        

# url-shortener-bot
Messenger bot to shorten urls

![Bot](https://dl.dropboxusercontent.com/u/45971143/url-shortener-bot.gif)

## How does that work?
It uses the [url-shortener](https://github.com/Philmod/url-shortener) service to shorten a requested url.
If a shortened url is passed, the bot will give you the opportunity to get statistics about it.

## Install and Run
- Install Node.js and NPM, by downloading and installing from https://nodejs.org/en/
- Install Node.js modules for this project
```
npm install
```
- [Set up a Facebook App and Page](https://developers.facebook.com/docs/messenger-platform/quickstart), update your `/config/` file with the `facebook_verif_token` and `facebook_page_token`
- Run a local url-shortener server (and define the config parameter `url_shortener_url`)
- Run this server:
```
npm start
```

## Tests
```
npm test
```

### Circle CI
Circle CI is configured and will run all the tests whenever a commit is pushed to this repository.

![Circle CI](https://circleci.com/gh/Philmod/url-shortener-bot/tree/master.svg?style=svg)