service-reporting/README.md

   1 # PDF Service
   2
   3 Provides an API interface 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 ```javascript
  13 [
  14   { "name": "term 1", "sentiment": 0.1 },
  15   { "name": "term 2", "sentiment": 0.3 },
  16   { "name": "term 3", "sentiment": 0.7 }
  17 ]
  18 ```
  19 - return: pdf file
  20
  21 ### Tweet model
  22 Term(string `Name`, double `Sentiment`)
  23
  24 ## run with docker
  25
  26 - `docker build -t service-reporting .`
  27 - `docker run -p YOUR_PORT:80 service-reporting:latest`
  28
  29 ## run local
  30 ### requirements
  31 - .net core 2.2
  32 - 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
  33 ### commands
  34 - `dotnet run`