wiki.ziemers.de

ziemer's informatik Wiki

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Zuletzt angesehen:
wiki:software:beuthbot:weather-service

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen Revision Vorhergehende Überarbeitung
Nächste Überarbeitung 		Vorhergehende Überarbeitung
wiki:software:beuthbot:weather-service [13.12.2019 09:51]
Timo Bruns [Getting Started] 		wiki:software:beuthbot:weather-service [22.07.2020 18:09] (aktuell)
Denny Schumann
Zeile 7: Zeile 7:
 ===== Table of content===== ===== Table of content=====
  
-- [Weather microservice](#weather-microservice) +  - [[wiki:software:beuthbot:weather-service#weather_microservice|Weather microservice]] 
-  - [Table of content](#table-of-content) +  - [[wiki:software:beuthbot:weather-service#table_of_content|Table of content]] 
-  - [Getting Started](#getting-started) +  - [[wiki:software:beuthbot:weather-service#getting-started|Getting Started]] 
-    - [Prerequisites](#prerequisites) +    - [[wiki:software:beuthbot:weather-service#prerequisites|Prerequisites]] 
-    - [Cloning](#cloning) +    - [[wiki:software:beuthbot:weather-service#cloning|Cloning]] 
-    - [Installing](#installing) +    - [[wiki:software:beuthbot:weather-service#installing|Installing]] 
-  - [Overview](#overview) +  - [[wiki:software:beuthbot:weather-service#overview|Overview]] 
-    - [Structure](#structure) +    - [[wiki:software:beuthbot:weather-service#structure|Structure]] 
-    - [Functionalities](#functionalities) +    - [[wiki:software:beuthbot:weather-service#functionalities|Functionalities]] 
-      - [The scripts-folder](#the-scripts-folder) +      - [[wiki:software:beuthbot:weather-service#the_scripts_folder|The scripts-folder]] 
-      - [The services-folder](#the-services-folder) +      - [[wiki:software:beuthbot:weather-service#the_services_folder|The services-folder]] 
-          - [generateResponse.js](#generateresponsejs) +          - [[wiki:software:beuthbot:weather-service#generateresponsejs|generateResponse.js]] 
-          - [weatherService.js](#weatherservicejs) +          - [[wiki:software:beuthbot:weather-service#weatherservicejs|weatherService.js]] 
-          - [fiveDayWeatherService.js](#fivedayweatherservicejs) +          - [[wiki:software:beuthbot:weather-service#fivedayweatherservicejs|fiveDayWeatherService.js]] 
-      - [The routes-folder](#the-routes-folder) +      - [[wiki:software:beuthbot:weather-service#the_routes_folder|The routes-folder]] 
-  - [Further Development](#further-development) +  - [[wiki:software:beuthbot:weather-service#further_development|Further Development]] 
-  - [Further Reading](#further-reading) +  - [[[wiki:software:beuthbot:weather-service#further_reading|Further Reading]] 
-  - [Built With](#built-with) +  - [[wiki:software:beuthbot:weather-service#built_with|Built With]] 
-  - [Versioning](#versioning) +  - [[wiki:software:beuthbot:weather-service#versioning|Versioning]] 
-  - [Authors](#authors)+  - [[wiki:software:beuthbot:weather-service#authors|Authors]]
  
 ===== Getting Started ===== ===== Getting Started =====
Zeile 52: Zeile 52:
 ''npm --version'' ''npm --version''
  
-If you don't have node or npm installed, download the Softare via the links provided in [[wiki:software:beuthbot:weather-service#prerequisites|Prerequisites]]or search for them via your preferred search engine.+If you don't have node or npm installed, download the Softare via the links provided in [[wiki:software:beuthbot:weather-service#prerequisites|Prerequisites]] or search for them via your preferred search engine.
  
 After that install all necessesary dependencies After that install all necessesary dependencies
Zeile 68: Zeile 68:
 ===== Overview ===== ===== Overview =====
  
-The weather microservice is basically a _Node_-_Express_-Backend. Incoming requests are checked and specifically handled. It can give you a general forecast for the next five days or a detailed forecast for the current day.+The weather microservice is basically a //Node//-//Express//-Backend. Incoming requests are checked and specifically handled. It can give you a general forecast for the next five days or a detailed forecast for the current day.
  
 === Structure === === Structure ===
Zeile 76: Zeile 76:
 === Functionalities === === Functionalities ===
  
-On request, this microservice makes calls to the [OpenWeatherMap API](https://openweathermap.org/api). The received data is processed by services that return a nicely formatted string containing the weather forecast for Berlin. Mainly this service was built throughout the Masterprojekt module that is a mandatory part of the media informatics master course of the Beuth University for Applied Sciences.+On request, this microservice makes calls to the [[https://openweathermap.org/api|OpenWeatherMap API]]. The received data is processed by services that return a nicely formatted string containing the weather forecast for Berlin. Mainly this service was built throughout the Masterprojekt module that is a mandatory part of the media informatics master course of the Beuth University for Applied Sciences.
  
 == The scripts-folder == == The scripts-folder ==
  
-This folder contains two scripts, that will be called by a cron job multiple times a day, since we can only do a maximum of 60 requests to the API per day. ''getWeather.js'' makes a request to the [OpenWeatherMap API](https://openweathermap.org/api) and caches the answer. After that ''writeResponseFile.json'' is called and generates a pretty formatted answer-string. Now everytime a User wants to know the current weather forecast, we can just read it out of the cached data and don't need to call the API.+This folder contains two scripts, that will be called by a cron job multiple times a day, since we can only do a maximum of 60 requests to the API per day. ''getWeather.js'' makes a request to the [[https://openweathermap.org/api|OpenWeatherMap API]] and caches the answer. After that ''writeResponseFile.json'' is called and generates a pretty formatted answer-string. Now everytime a User wants to know the current weather forecast, we can just read it out of the cached data and don't need to call the API.
  
 == The services-folder == == The services-folder ==
Zeile 86: Zeile 86:
 This folder consists of several services, that perform specific tasks for the microservice. This folder consists of several services, that perform specific tasks for the microservice.
  
-**generateResponse.js** +== generateResponse.js ==
  
 Creates a nicely formatted string from a weather-JSON-object and caches it. Creates a nicely formatted string from a weather-JSON-object and caches it.
  
-** weatherService.js **+== weatherService.js ==
  
 Makes a request to the ''OpenWeatherMap-API'' to get the current weather forecast and stores the response. Makes a request to the ''OpenWeatherMap-API'' to get the current weather forecast and stores the response.
  
-** fiveDayWeatherService.js **+== fiveDayWeatherService.js ==
  
 If a weather forecast for the next days is requested, than this script requests the necessary data from the ''OpenWeatherMap-API'' and stores its response. If a weather forecast for the next days is requested, than this script requests the necessary data from the ''OpenWeatherMap-API'' and stores its response.
Zeile 108: Zeile 108:
 ===== Further Reading ===== ===== Further Reading =====
  
-- [OpenMensa API](https://doc.openmensa.org/api/v2/)+- [[https://doc.openmensa.org/api/v2/|OpenMensa API]]
  
 ===== Built With ===== ===== Built With =====
  
-- [Node.js](https://nodejs.org/en/) +- [[https://nodejs.org/en/|Node.js]] \\  
-- [Express.js](https://expressjs.com/) +- [[https://expressjs.com/|Express.js]] \\  
-- [Axios](https://www.npmjs.com/package/axios)+- [[https://www.npmjs.com/package/axios|Axios]]\\ 
  
 ===== Versioning ===== ===== Versioning =====
  
-We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/<you>/<your-repo>/tags).+We use  [[http://semver.org/|SemVer]] for versioning. For the versions available, see the [[https://github.com/<you>/<your-repo>/tags|tags on this repository]].
  
 ===== Authors ===== ===== Authors =====
  
-- **Tolga Karaoglu**+- **Tolga Karaoglu** \\ 
 - **Steven Sobkowski** - **Steven Sobkowski**
  
-See also the list of [contributors](https://github.com/<you>/<your-repo>/contributors) who participated in this project. +See also the list of [[[https://github.com/<you>/<your-repo>/contributors|contributors]] who participated in this project. 
 +<WRAP pagebreak></WRAP>
wiki/software/beuthbot/weather-service.1576227073.txt.gz · Zuletzt geändert: 13.12.2019 09:51 von Timo Bruns

Seiten-Werkzeuge