1
0
mirror of https://github.com/franjsco/umbrello-api synced 2024-12-10 16:07:36 +01:00
umbrello-api/README.md
Francesco Esposito 96a303555e Edit username
2020-03-01 23:50:34 +01:00

1.1 KiB

umbrello-api

Rest API for umbrello-bot.

The weather information is based on OpenWeatherMap API.

Technologies:

  • Node.js
  • express
  • mongodb

Installation

  1. Install Node.js and npm.
  2. Install mongodb.
  3. Clone this repository.
  4. Install dependencies with npm install
  5. Create env file or set environment variables. (read "Environment variables" paragraph)
  6. Configure the list of city id (read "OpenWeatherMap - List Of City ID")
  7. Build with npm run build.
  8. Start the server with npm run serve.

Environment Variables.

OWM_TOKEN=your-open-weather-map-token-api
OWM_LANG=en
OWM_UNITS=metric

TELEGRAM_TOKEN=your-telegram-bot-token

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

OpenWeatherMap - List Of City ID

  1. Download city.list.min.json.gz
  2. Extract the json.
  3. Import the json into MongoDB (collection: umbrello_cities).

License

GPLv3


Made with ❤️ by Francesco Esposito (@franjsco)