Maltrn / project-aim

Anbieter Informations Management (A.I.M)

This microservice can add and maintain additional data to pbx provider and their products.

It is build on the Edison Microservice and uses Angular.

Backend

Usage

This project uses gradle to build everything. There is a custom script to start the server, do all the testing and so on.

To run the microservice simply use the go script:

./bin/go bootRun

To test everything run:

./bin/go test

If you want to build the jar with all dependencies do:

./bin/go bootRepackage

The jar will then be under: ./build/libs/projecttwomicroservice.jar

The server will be available under: http://localhost:8080/api

Swagger will be available under: http://localhost:8080/api/swagger-ui.html

Configurations

All configurable settings for the backend can be found in the ./src/main/resources folder.

The application.properties file contains all applications settings like the mongo db host, port, etc. All other settings like accepted length of characters or accepted file types can be found in the config.properties

Frontend

Usage

This project uses webpack to build everything and start the frontend. To start or stop the server change into its directory:

cd frontend

To run the microservice:

npm start

The server will be available under: http://localhost:3000

Configurations

All configurable variables can be found in the file: ./frontend/src/app/app.config.ts.

Docker

We use docker to build images to make the microservice deployable in containers. There are currently three images for this microservice.

• Backend This image contains the backend
• Frontend This image contains the frontend
• TestDB This image contains a MongoDB with test data that can be imported.

For more information read the instructions on each docker hub page.

Fragenkatalog

• Wie sehen die Schnittstellen aus die wir von den anderen Systemen nutzen können?
  • Es gibt nur eine Schnitstelle die wir nutzen, nämlich die Login-Schnitstelle. Diese soll von uns gemockt werden. Ggf. bekommen wir im Laufe des Projektes Zugriff auf die echte Login-Schnitstelle.
• Wie soll die Schnitstellen aussehen die wir nach außen anbieten?
  • Die Schnittstelle soll in Absprache mit dem Kunden entwickelt werden, dazu sollen wir aber einen Entwurf vorlegen, den wir als Grundlage für diese Entwicklung nutzen können. Unsere Schnittstelle soll alle Daten über REST anbieten können, die wir auf der Anbieter Seite aufnehmen. Dabei ist es noch komplett frei wie wir diese Daten anbieten.
• Wie soll das GUI aussehen?
  • Keine Vorgaben vom Kunden
• Welche Daten sollen gespeichert werden?
  • Grundsätzlich sollen alle Daten gespeichert werden, welche der Anbieter auf unserer Microservices Seite eingeben kann:
  • Name (kommt aus dem anderen System, kann nicht verändert werden)
  • Kurzbeschreibung
  • Lange Beschreibung
  • Hauptbild
  • Bilder-/PDF-Galerie Inhalte
  • Fakten-Tabelle
• Welche Formate sollen für Produktbroschüren und Bilder unterstützt werden?
  • PDF für Broschüren
  • mindestens JPG, PNG, GIF für die Bilder
• Wo finden wir die Schnittstellenbeschreibungen?
  • Bisher noch gar nicht, so lange sollen die Schnittstellen gemockt werden, ggf. werden die Beschreibungen nachgereicht.
• Welche Funktionen sollen zusätzlich abgedeckt werden?
  • Teaser und Name sollen in der Länge begrenzbar sein (config-file)
  • Für die Lange Beschreibung soll es möglich sein, den Text via Rich-Text Editor zu formatieren (je mehr Funktionen desto besser)
  • Eingabe in den Editor für Lange Texte soll kompatibel mit Word Copy&Paste sein
  • Bilder sollen beim Hochladen vom Kunden sortiert werden können

Tools

• Slack
• IntelliJ