franjsco
/
umbrello-bot
mirror of https://github.com/franjsco/umbrello-bot
1
0
Fork 0
Code Issues Releases Wiki Activity
27 Commits 15 Branches 2 Tags 2.5 MiB
JavaScript 97.7%
Dockerfile 2.3%
Go to file
dependabot[bot] cc199a1567
Bump minimist from 1.2.5 to 1.2.6 
Bumps [minimist](https://github.com/substack/minimist) from 1.2.5 to 1.2.6.
- [Release notes](https://github.com/substack/minimist/releases)
- [Commits](https://github.com/substack/minimist/compare/1.2.5...1.2.6)

---
updated-dependencies:
- dependency-name: minimist
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
 		2022-03-26 06:23:27 +00:00
src Edit username 2020-03-01 23:43:01 +01: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 update readme 2020-05-19 15:34:03 +02:00
package-lock.json Bump minimist from 1.2.5 to 1.2.6 2022-03-26 06:23:27 +00:00
package.json Bump axios from 0.19.2 to 0.21.1 2021-01-05 21:33:52 +00:00
screenshot.jpg update readme & dependencies 2020-05-19 15:28:41 +02:00

README.md

Welcome to umbrello-bot ☂️

License: GPL--3.0--or--later Twitter: franjsco

A telegram bot to know if you need to take the umbrella.

Install

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

Usage

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

Build Docker image

# cd umbrello-bot/
# docker build -t umbrello-bot .
# docker run umbrello-bot

Author

👤 franjsco (Francesco Esposito)

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2020 franjsco (Francesco Esposito).
This project is GPL--3.0--or--later licensed.

This README was generated with ❤️ by readme-md-generator