Commit 2ec342ae authored by Nuno Alves's avatar Nuno Alves
Browse files

update readme file

parent 31cc2a9c
# PDFGenerator # PDFGenerator
## First steps as a normal application In diesem Repository geht es um die Generierung von PDF-Dokumenten über Microservices via Web-Api. Eine WebUi wird zusätzlich zum Testen von Anfragen mit Dateneingabe bereitgestellt.
### With Visual Studio Dies Web Api generiert entweder einen Evaluationsbericht oder ein Factsheet je nach aufgerufenem URI und gibt das PDF-Dokument als byte Array zurück.
#### Installation ## Einstellung
1. Install Visual Studio 2019 with .NET Core extension packs - TargetFramework: .NET Core 3.1
- PDF Library: iText7 (Version="7.1.12")
#### Setup ## Generierung des Evaluationsbrichts
1. Open the Solution file Als Erstes wird ein _EvaluationReportRenderer_ mit dem EvaluationReport-Inhalt aus dem Request-Body instantiiert, der für die Erstellung des PDF-Dokuments mit dem zugehörigen Inhalt zuständig ist.
2. Change debug profile to `pdf-generator`
3. Start debugging either via play button or press F5 and a web browser will open the Swagger UI
### With Visual Studio Code Mittels _RenderSections_ wird danach jeder einzelner Abschnitt ins Dokument geschrieben. Da das Inhaltsverzeichnis als letzter Abschnitt gerendert wird und direkt hinter dem Deckblatt liegen soll, werden die Seiten anschließend umsortiert (_MoveTocToFront_). Als Nächtes wird eine Kopfzeile fürs ganze Dokument geschrieben (_AddHeader_).
#### Installation Zuletzt wird das Dokument als byte-Feld zurükgegeben.
1. Install Visual Studio Code with the following extensions:
- C# from Microsoft (Prompt: Yes including the requested framework)
- C# XML Documentation Comments from Keisuke Kato
- C# Extensions from JosKreativ
2. Install .NET Core SDK (https://dotnet.microsoft.com/download/dotnet-core/3.1)
#### Setup
1. Go into project directory `.\pdfgenerator\pdf-generator`.
2. Run the following command to restore the required packages:
```bash
dotnet restore
```
3. Run the following command to build the project:
```bash
dotnet build
```
4. Open the project directory in Visual Studio Code for working and debugging. To start debugging, simply press `F5` and the Swagger UI will open in browser immediately
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment