From 55ce0288352847dd4d1f4aa8c055ff2f1b15562d Mon Sep 17 00:00:00 2001
From: Andri Joos <andri@joos.io>
Date: Thu, 13 Jun 2024 19:56:52 +0200
Subject: [PATCH] fix toolstack
---
.../architecture/toolstack.tex | 12 ++++++++----
1 file changed, 8 insertions(+), 4 deletions(-)
diff --git a/src/02_product-documentation/architecture/toolstack.tex b/src/02_product-documentation/architecture/toolstack.tex
index 6f1ce59..4ccc88e 100644
--- a/src/02_product-documentation/architecture/toolstack.tex
+++ b/src/02_product-documentation/architecture/toolstack.tex
@@ -39,12 +39,12 @@
As the code must run as a web service, \href{https://pypi.org/project/uvicorn/}{uvicorn} is utilized.
\paragraph{openai-whisper}
- \href{https://pypi.org/project/openai-whisper/}{openai-whisper} is a speech-to-text model and is used as an alternative to whisper accessible via the OpenAI API.
+ \href{https://pypi.org/project/openai-whisper/}{Openai-whisper} is a speech-to-text model and is used as an alternative to whisper accessible via the OpenAI API.
This, because there may be people, which are not willing to share their voice with OpenAI.
With the locally hosted whisper, this can be guaranteed.
\paragraph{pydub}
- \href{https://pypi.org/project/pydub/}{pydub} is a package to handle and analyze audio data.
+ \href{https://pypi.org/project/pydub/}{Pydub} is a package to handle and analyze audio data.
It is used for the speech-to-text part of the application.
\paragraph{cachetools}
@@ -52,7 +52,7 @@
\subsection{Programming Languages}
\subsubsection{JavaScript}
- The web-application's frontend is written in JavaScript, specifically in React.
+ The web-application's frontend is written in JavaScript.
\subsubsection{C\#}
The web-application's backend is written in C\#.
@@ -64,10 +64,14 @@
\subsubsection{Docker}
Docker is used to containerize all services of the application.
+ \subsubsection{Gitlab CI}
+ The Smart Eating Docker images are built using Gitlab CI.
+ In addition, Gitlab CI is used to compile the documentation into a pdf.
+
\subsection{Documentation}
The documentation is written in \LaTeX, which makes collaboration and source control easy.
Additionally, it allows to generate a pdf, which is the preferred format for reports.
\subsubsection{Diagrams}
- Most of the diagrams are created as \enquote{diagrams as code} in python using the \href{https://pypi.org/project/diagrams/}{diagrams package} in markdown using \href{https://mermaid.js.org/}{mermaid}.
+ Most of the diagrams are created as \enquote{diagrams as code} in python using the \href{https://pypi.org/project/diagrams/}{diagrams package} and in markdown using \href{https://mermaid.js.org/}{mermaid}.
The long-term Gantt-Chart, however, is created using Microsoft Excel.
--
GitLab