feat: app release notes

backend/backend/config/default/app/index.js

@@ -22,6 +22,7 @@ const app = {
   name: 'Goethe-Uni',
   privacyPolicyUrl: 'https://mobile.server.uni-frankfurt.de/_static/privacy.md',
   settings: [userGroupSetting, languageSetting],
+  versionHistory: [],
 };
 
 export default app;

backend/backend/config/default/tools/version.js

@@ -0,0 +1,42 @@
+// @ts-check
+import {readFile} from 'fs/promises';
+
+/**
+ * @example version(1, import.meta.url)
+ * @param options {Omit<import('@openstapps/core').SCAppVersionInfo, 'releaseNotes' | 'translations'>}
+ * @param base {string}
+ * @returns {Promise<import('@openstapps/core').SCAppVersionInfo>}
+ */
+export async function version(options, base) {
+  const de = await readFile(new URL(`${options.version}.de.md`, base), 'utf8');
+  const en = await readFile(new URL(`${options.version}.en.md`, base), 'utf8');
+
+  return {
+    ...options,
+    releaseNotes: de,
+    translations: {
+      en: {
+        releaseNotes: en,
+      },
+    },
+  };
+}
+
+/**
+ * @param infos {Record<string, import('@openstapps/core').SCAppVersionInfo['published']>}
+ * @param base {string} Base path of the file as `import.meta.url`
+ * @returns {Promise<import('@openstapps/core').SCAppVersionInfo[]>}
+ */
+export async function versions(infos, base) {
+  return Promise.all(
+    Object.entries(infos).map(([versionName, published]) =>
+      version(
+        {
+          published,
+          version: versionName,
+        },
+        base,
+      ),
+    ),
+  ).then(it => it.sort(({version: a}, {version: b}) => -a.localeCompare(b, undefined, {numeric: true})));
+}

backend/backend/config/f-u/backendrc.js

@@ -2,6 +2,7 @@
 import aboutPages from './about-pages/index.js';
 import defaultApp from '../default/app/index.js';
 import {backend as defaultBackend, internal as defaultInternal} from '../default/backend/index.js';
+import versionHistory from './version-history/index.js';
 
 /**
  * This is the default configuration for the Goethe university of Frankfurt
@@ -76,6 +77,7 @@ const config = {
         } */
       },
     },
+    versionHistory,
     aboutPages,
   },
   backend: defaultBackend,

backend/backend/config/f-u/version-history/3.1.0.de.md

@@ -0,0 +1,52 @@
+# Goethe-Uni App 3.1
+
+Wir freuen uns euch mehr in der Goethe-Uni App
+bieten zu können.
+
+## Navigation zu Gebäuden und Orten
+
+Als eines der Ergebnisse des Ideenwettbewerbs wurde jetzt
+ein Navigationsfeature in die App integriert.
+
+Orte auf der Karte, Mensen, sowie sogar Termine (wenn hinterlegt)
+bieten jetzt direkt die Option eine Verbindung zu finden, gestützt
+durch die Karten App auf deinem Gerät.
+
+## Integration der Jobbörse
+
+Jobs findest du ab sofort auch in der Goethe-Uni App.
+
+Auch das ist ein Ergebnis des Ideenwettbewerbs,
+und wir freuen uns es euch hier präsentieren zu können!
+
+## Der Umweltscore
+
+Der Umweltscore für Gerichte wird nun auch in der App angezeigt.
+
+> Nachhaltigkeit, Umweltschutz, Gesundheit und Klimawandel sind
+> zentrale Begriffe im gesellschaftlichen Miteinander.
+> Unsere Ernährung spielt hierbei eine wichtige Rolle.
+> Das Studierendenwerk Frankfurt am Main zeichnet seine Speisenpläne
+> ab sofort mit einem Umweltscore aus.
+> Anhand dieser Bewertung können Sie direkt ersehen,
+> welchen Einfluss Ihre Essenauswahl auf das Klima hat.
+
+## Weitere Verbesserungen
+
+### Performance
+
+Die Performance der App beim Navigieren wurde stark verbessert und ist datensparender.
+
+### Kalender
+
+Die Kalenderabschnitte haben jetzt neue Namen bekommen:
+
+- Der _Kalender_ zeigt Termine für spezifische Tage
+- Die _Wochenübersicht_ ist ein Stundenplan mit allen Termine, die sich wiederholen (z. B. Vorlesungen)
+- Die _Einzeltermine_ zeigen alle Termine, die sich nicht wiederholen
+  (z. B. Klausuren)
+
+### Meine App
+
+Der "Meine Kurse" Abschnitt wurde überarbeitet, und zeigt jetzt Termine
+für die nächsten Tage und mit mehr Details an.

backend/backend/config/f-u/version-history/3.1.0.en.md

@@ -0,0 +1,49 @@
+# Goethe-Uni App 3.1
+
+The Goethe-Uni App got even better!
+
+## Navigation to buildings and places
+
+As part of the "Ideenwettbewerb," the idea competition,
+we have now integrated a navigation feature into the app.
+
+Orte auf der Karte, Mensen, sowie sogar Termine (wenn hinterlegt)
+bieten jetzt direkt die Option eine Verbindung zu finden, gestützt
+durch die Karten App auf deinem Gerät.
+
+## Integration of the job market
+
+Jobs are now also available in the Goethe-Uni App.
+
+This feature is also a result of the idea competition,
+and we're happy to be able to present it to you here!
+
+## The environment score
+
+The environment score for dishes is now displayed inside the app.
+
+> Sustainability, environment protection, health, and climate change are
+> central topics in how we live today in our society.
+> Our eating habits play an important role in it.
+> The "Studierendenwerk Frankfurt am Main" is marking up its menus
+> from now on with the so-called "Umweltscore," the environment score.
+> Based on this rating, you can see the impact your meal choice would have on our climate.
+
+## Further improvements
+
+### Performance
+
+The performance while navigating around the app has been heavily improved and requires less data to work.
+
+### Calendar
+
+The calendar sections have new names:
+
+- The _calendar_ shows appointments on specific days
+- The _week overview_ is a schedule with all events that repeat (e.g. lectures)
+- The _single events_ show all appointments that don't repeat (e.g. exams)
+
+### My App
+
+The "my courses" section has been revamped,
+and now shows events for the next days and with more detail.

backend/backend/config/f-u/version-history/index.js

@@ -0,0 +1,12 @@
+// @ts-check
+import {versions} from '../../default/tools/version.js';
+
+/** @type {import('@openstapps/core').SCAppVersionInfo[]} */
+const versionHistory = await versions(
+  {
+    '3.1.0': {},
+  },
+  import.meta.url,
+);
+
+export default versionHistory;