Go to file
Francesco Esposito 8ea843cbdd Edit .env sample 2019-08-26 17:47:29 +02:00
assets Edit readme 2019-08-26 17:19:52 +02:00
src Add server 2019-08-22 17:31:40 +02:00
.babelrc Setup project 2019-08-22 17:21:27 +02:00
.dockerignore Add Dockerfile 2019-08-26 15:21:35 +02:00
.editorconfig Initial setup 2019-08-16 15:33:07 +02:00
.env.sample Edit .env sample 2019-08-26 17:47:29 +02:00
.eslintrc.js Setup project 2019-08-22 17:21:27 +02:00
.gitignore Initial setup 2019-08-16 15:33:07 +02:00
Dockerfile edit Dockerfile 2019-08-26 15:40:00 +02:00
LICENSE Initial commit 2019-08-16 15:22:12 +02:00
README.md Edit readme 2019-08-26 17:28:43 +02:00
package-lock.json Setup project 2019-08-22 17:21:27 +02:00
package.json Setup project 2019-08-22 17:21:27 +02:00

README.md

umbrello-bot

An opensource telegram bot to know if you need to take the umbrella.

Technologies:

  • Node.js
  • Telegraf.js

Usage

umbrello-bot uses the umbrello-api to get weather information.

1. Search the city.

Search the city id with:

/search [city name] 

example: /search Roma

It will send back the cities id.

2. Set the city.

Set the city wth:

/set [city id]

example: /set 3169070. (3169070= Rome, IT)

3. Get the forecasts.

Get the forecasts with:

/get

Installation

Step by step.

  1. Install Node.js and npm.
  2. Configure umbrello-api.
  3. Clone this repository.
  4. Install dependencies with npm install.
  5. Create a new bot with BotFather on Telegram
  6. Create env file or set environment variables (read: "Environment variables")
  7. Build the code with npm run build.
  8. Launch the bot with npm run serve.

Environment Variables.

NODE_ENV=production
TELEGRAM_TOKEN=token-here
UMBRELLO_API_URL=url-here

DB_HOST=mongodb://host:port/db
DB_USER=user
DB_PASSWORD=pass

Build Docker image

# docker build -t umbrello-bot:1.0 .
# docker run umbrello-bot:1.0

License

GPLv3


Made with ❤️ by Francesco Esposito (@frsposito)