Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

--- wiki:software:beuthbot:mensa-service [13.12.2019 09:33]
Christopher Lehmann angelegt
+++ wiki:software:beuthbot:mensa-service [24.01.2020 15:12] (aktuell)
Tolga Karaoglu [Versioning]
@@ Zeile 1: / Zeile 1: @@
-test
+===== Mensa Microservice =====
+A microservice for a Chatbot developed at the Beuth University of Applied Sciences Berlin
+==== Table of content ====
+	- [[wiki:software:beuthbot:mensa-service#mensa microservice|Mensa Microservice]]
+	- [[wiki:software:beuthbot:mensa-service#table of content|Table Of Content]]
+	- [[wiki:software:beuthbot:mensa-service#Getting Started|Getting Started]]
+		- [[wiki:software:beuthbot:mensa-service#prerequisites|Prerequisites]]
+		- [[wiki:software:beuthbot:mensa-service#cloning|Cloning]]
+		- [[wiki:software:beuthbot:mensa-service#installing|Installing]]
+	- [[wiki:software:beuthbot:mensa-service#overview|Overview]]
+	- [[wiki:software:beuthbot:mensa-service#structure|Structure]]
+	- [[wiki:software:beuthbot:mensa-service#Functionalities|Functionalities]]
+	- [[wiki:software:beuthbot:mensa-service#the services-folder|The Services-Folder]]
+		- [[wiki:software:beuthbot:mensa-service#generateResponse.js|generateResponse.js]]
+		- [[wiki:software:beuthbot:mensa-service#mealService.js|mealService.js]]
+		- [[wiki:software:beuthbot:mensa-service#mealsOfSpecificDayService.js|mealsOfSpecificDayService.js]]
+	- [[wiki:software:beuthbot:mensa-service#the routes-folder|The Routes-Folder]]
+	- [[wiki:software:beuthbot:mensa-service#further development|Further Development]]
+	- [[wiki:software:beuthbot:mensa-service#further reading|Further Reading]]
+	- [[wiki:software:beuthbot:mensa-service#built with|Built With]]
+	- [[wiki:software:beuthbot:mensa-service#versioning|Versioning]]
+	- [[wiki:software:beuthbot:mensa-service#authors|Authors]]
+==== Getting Started ====
+=== Prerequisites ===
+- [[https://nodejs.org/en/|node.js]]\\
+- [[https://expressjs.com/|express.js]]
+=== Cloning ===
+Get the source code by cloning its repository via https: [[https://github.com/Onkilchen/mensa_microservice|mensa_microservice]]
+=== Installing ===
+After cloning the repository, you will need to make sure that you have node and npm installed on your working system. To check if you already have node installed, try\\
+\\
+''node --version''\\
+\\
+Same for checking if npm is installed, just with npm instead of the node command\\
+\\
+''npm --version''
+If you don't have node or npm installed, download the software via the links provided in [[wiki:software:beuthbot:mensa-service#prerequisites|Prerequisites]] or search for them via your preferred search engine([[https://duckduckgo.com|DuckDuckGo]]).\\
+\\
+After that install all necessesary dependencies in the directory where the package.json exists\\
+\\
+''npm install''\\
+\\
+Now you can start the local development server to play around with the API and make your calls\\
+\\
+''npm run dev''\\
+\\
+This will fire up a development server that listens on port 8000.\\
+\\
+If you direct your browser to http://localhost:8000/meals, you will get a list of the meal plan of the actual day for the mensa at the Beuth University for Applied Sciences.
+==== Overview ====
+The mensa microservice is basically a //Node//-//Express//-Backend. Incoming requests are checked and specifically handled.
+==== Structure ====
+The microservice consists of four folders containing several scripts, which are designated to perform certain tasks. Then we have the **services**-folder containing files, that consist of functions useful to process incoming requests from the chatbot and to generate a formatted answer-string, that contains the requested meal-menu of a specific day from the Beuth mensa. The **routes**-folder consists of all the routes, that can be addressed. In the next chapters we will get into more details about the scripts and their functions.
+==== Functionalities ====
+On request, this microservice makes calls to the [[https://doc.openmensa.org/api/v2/|OpenMensa API]]. The received data is processed by services that give a list of filtered and unfiltered meals of the mensa of the Beuth University for Applied Sciences. 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.
+==== Project structure ====
+=== The services-folder ===
+This folder consists of several services, that perform specific tasks for the microservice.
+== generateResponse.js ==
+Creates a nicely formatted string from a mensa-JSON-object and caches it.
+== mealsOfSpecificDay.js ==
+Makes a request to the OpenMensa API and filters by given entities (for instance vegan and vegetarian meals only).
+=== The routes-folder ===
+This folder contains all the routes, that can be addressed on this server. The `index.js` manages all the routes. We've only got two routes in our project. The `/swagger`-route leads you to the swagger documentation of this project.
+The `/meals`-route will be called by another component of the Beuthbot via `POST`. It expects a message JSON-object containing the requested date for the meals and the filters - to request only specific meals. It then calls all the functions needed to perform requests and generates an answer, which is finally send back as a response to the Chatbot.
+==== Further Development ====
+This is still a work in progress, so functionalities and structure might still change during development
+==== Further Reading ====
+- [[https://doc.openmensa.org/api/v2/|OpenMensa API]]
+==== Built With ====
+- [[https://nodejs.org/en/|Node.js]]\\
+- [[https://expressjs.com/|Express.js]]\\
+- [[https://www.npmjs.com/package/axios|Axios]]
+==== Versioning ====
+We use [[http://semver.org/|SemVer]] for versioning. For the versions available, see the [[https://github.com/Onkilchen/mensa_microservice/tags|tags]] on this repository.
+==== Authors ====
+- **Tolga Karaoglu**\\
+- **Steven Sobkowski**\\
+\\
+See also the list of [[https://github.com/Onkilchen/mensa_microservice/contributors) who participated in this project|contributors]].
+<WRAP pagebreak></WRAP>

wiki.ziemers.de

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Unterschiede

Seiten-Werkzeuge