service-reporting/README.md

   1 # PDF Service
   2
   3 Provides a REST-API to generate PDF reports for terms and their sentiment analysis results. The service uses an .NET Core wrapper for the wkhtmltopdf library to generate pdf out of html code.
   4
   5 `GET`: `/` Shows a demo page
   6 - param: none
   7 - return: pdf file
   8
   9 `POST`: `/generatePDF/` Generates a pdf report for the given terms
  10 - param: Term[] as Content-Type: `application/json`
  11 e.g. body of request
  12 ```json
  13 [
  14   {
  15     "name": "term 1",
  16     "sentiment": 0.1
  17   },
  18   {
  19     "name": "term 2",
  20     "sentiment": 0.3
  21   },
  22   {
  23     "name": "term 3",
  24     "sentiment": 0.7
  25   }
  26 ]
  27 ```
  28 - return: pdf file
  29
  30 ### Tweet model
  31 Term(string `Name`, double `Sentiment`)
  32
  33 ## run with docker
  34
  35 - `docker build -t service-reporting .`
  36 - `docker run -p YOUR_PORT:8083 service-reporting:latest`
  37
  38 ## run local
  39 ### requirements
  40 - .net core 2.2
  41 - download [libwkhtml library](https://github.com/rdvojmoc/DinkToPdf/tree/master/v0.12.4) depending on your operating system and put it into `service-reporting` root folder
  42 ### commands
  43 - `dotnet run`