JavaScript-SDK: Markdown-Files + Testinfrastruktur

Warum?

Ziel dieses Issue ist es, das JavaScript-SDK zugänglicher für Dritte zu machen. Dazu soll die Dokumentation zur Nutzung des JavaScript-SDK erarbeitet und ein Changelog angelegt werden. Zudem soll die Testinfrastruktur (CI-Tests) fertig gestellt werden.

Relevante Links und Bemerkungen

Zu klären

  1. Soll die Dokumentation in der README.md oder im docs-Repo gepflegt werden?

Akzeptanzkriterien

  1. Es gibt eine Datei CHANGELOG.MD gemäß https://keepachangelog.com/de/1.0.0/.
  2. Die Datei CHANGELOG.MD enthält mindestens ein Grundgerüst analog zur Changelog-Datei im Java-SDK.
  3. Die Readme.md enthält alle nötigen Infos zum Einstieg in das SDK inkl. einer Motivation mit Link auf https://docs.fitko.de/fit-connect/docs/getting-started/encryption und einer Darstellung der in #413 (closed) beschriebenen Funktionalitäten inkl. Code-Beispielen (## Usage). Hierbei kann zunächst davon ausgegangen werden, dass das SDK nur in Onlinediensten (Sendern) zum Einsatz kommt.
  4. In der Readme.md finden sich Informationen zum Kompilieren des SDK (## Build / ## Setup).
  5. In der Readme.md finden sich Informationen zu Feedback-Kanälen inkl. der Links https://docs.fitko.de/feedback-fitconnect (Issue-Tracker) sowie https://docs.fitko.de/fit-connect/contact/ (## Contributing) (-> siehe auch #927)
  6. Die Funktionalität des SDK wurde durch einen E2E-Test überprüft (via CI). Nötige Credentials werden als masked CI-Variablen hinterlegt.
  7. Im Peer Review wurde die Readme sowie weitere im SDK-Repo enthaltene Dokumentation auf Verständlichkeit und Konsistenz überprüft.

Durchführungsplan (von Entwickler:in bei Umsetzungsplanung auszufüllen)

Edited by Martin Vogel