|
1 | 1 | # Readme for Developer
|
2 | 2 |
|
3 |
| -## Einleitung |
| 3 | +## Introduction |
4 | 4 |
|
5 |
| -Dieses Repository enthält den Quellcode und die Inhalte für die nächste Generation der Prüfungsvorbereitung von Serlo. Es ist angedacht als eine selbstständige App zum Mathe-Üben. Sie ist als Web-App implementiert. Als Web-Framework kommt [next.js 14](https://nextjs.org/) zum Einsatz, für native Wrapper sind zudem [ionic 8](https://ionicframework.com/) und [capacitor 7](https://capacitorjs.com/docs) integriert. Das Haupt-Target ist aktuell Web. |
| 5 | +This repository contains the source code and content for the next generation of Serlo's exam preparation. It is designed as a standalone app for practicing math. The app is implemented as a web application. The web framework used is [next.js 14](https://nextjs.org/), and for native wrappers, [ionic 8](https://ionicframework.com/) and [capacitor 7](https://capacitorjs.com/docs) are also integrated. The primary target is currently the web. |
6 | 6 |
|
7 | 7 | ## Getting Started
|
8 | 8 |
|
9 |
| -Es wird [node.js v20](https://nodejs.org/en) oder höher benötigt. Führe nach dem Klonen des Repository im Hauptverzeichnis `npm start` aus. Dadurch werden alle Abhängigkeiten installiert und der Dev-Server auf http://localhost:3000/ gestartet. Du kannst auch `npm install` und `npm run dev` separat ausführen. |
| 9 | +[node.js v20](https://nodejs.org/en) or higher is required. After cloning the repository, run `npm start` in the main directory. This will install all dependencies and start the development server at [http://localhost:3000/](http://localhost:3000/). You can also run `npm install` and `npm run dev` separately. |
10 | 10 |
|
11 |
| -Erstelle ein production-build mit `npm run build`. Das Repository ist mit dem Serlo-Account von [vercel.com](https://vercel.com) und dort wird der Prototyp unter https://testtiger-nine.vercel.app/ gehostet. Pushe auf `main` für ein neues Deployment. |
| 11 | +Create a production build with `npm run build`. The repository is linked to the Serlo account on [vercel.com](https://vercel.com), and the prototype is hosted there at [https://testtiger-nine.vercel.app/](https://testtiger-nine.vercel.app/). Push to `main` for a new deployment. |
12 | 12 |
|
13 |
| -Das Repo enthält in `/backend` auch eine Backend-Server-Komponente. Führe `npm install` separat in diesem Repo aus und dann `npm start`. Das Backend wird aktuell dem Asteroid `testtige` des Serlo-Uberspace gehostet. Dort ist ein Verzeichnis `backend-testtiger` angelegt. Mit dem `./deploy.sh`-Script lässt sich eine neue Version des Servers deployen. |
| 13 | +The repository also includes a backend server component in the `/backend` directory. Run `npm install` separately in this directory and then `npm start`. The backend is currently hosted on the Asteroid `testtige` of the Serlo-Uberspace. A directory named `backend-testtiger` has been created there. A new version of the server can be deployed using the `./deploy.sh` script in the `backend-testtiger` directory. To access the Uberspace, [create a new ssh-key](https://manual.uberspace.de/basics-ssh/) via the Uberspace dashboard. |
14 | 14 |
|
15 |
| - Ordner- & Dateistruktur |
16 |
| - Verzeichnisaufbau: Erklärung der Hauptordner und deren Zweck (z.B. src, components, assets, styles, etc.). |
17 |
| - Namenskonventionen: Wie Dateien und Komponenten benannt werden. |
18 |
| - |
19 |
| - Technologien & Abhängigkeiten |
20 |
| - Frontend-Framework: (z.B. React, Vue, Angular) und kurze Begründung der Auswahl. |
21 |
| - Wichtige Libraries & Tools: Beschreibung der wichtigsten externen Pakete, Build-Tools, Linter, Formatter, etc. |
22 |
| - |
23 |
| - Entwicklungs- & Deployment-Prozess |
24 |
| - Workflow: Branching-Strategie, Code Reviews, Merge-Prozesse. |
25 |
| - Testing: Welche Testarten (Unit, Integration, E2E) implementiert sind und wie sie ausgeführt werden. |
26 |
| - CI/CD: Informationen zu automatisierten Tests, Builds und Deployments (z.B. über GitHub Actions, Jenkins o.ä.). |
27 |
| - |
28 |
| - Coding Guidelines & Best Practices |
29 |
| - Code-Style: Konventionen, die eingehalten werden (z.B. ESLint/Prettier-Konfigurationen). |
30 |
| - Commit-Messages: Vorlagen oder Regeln für sinnvolle Commit-Beschreibungen. |
31 |
| - |
32 |
| - Troubleshooting & FAQ |
33 |
| - Häufige Probleme: Bekannte Stolpersteine und deren Lösungen. |
34 |
| - Debugging-Tipps: Hilfreiche Tools und Vorgehensweisen zur Fehleranalyse. |
35 |
| - |
36 |
| - Weiterführende Ressourcen & Dokumentation |
37 |
| - Links: Zu externen Dokumentationen, Tutorials, oder Design-Guidelines. |
38 |
| - Kontakt & Support: An wen man sich bei Fragen wenden kann. |
39 |
| - |
40 |
| -Diese Struktur deckt alle wesentlichen Bereiche ab, die dein Nachfolger kennen sollte, um sich schnell zurechtzufinden und produktiv zu arbeiten. Natürlich kannst du je nach Komplexität deines Repos und den Bedürfnissen deines Teams einzelne Punkte noch erweitern oder anpassen. |
| 15 | +The backend is storing profiles in a database. Use https://mysql.uberspace.de/phpmyadmin/index.php?route=/sql&pos=0&db=testtige_backend&table=Profiles&server=117 to get access to the data, username is `testtige` and the mysql passwort can be found by typing `cat .my.cnf` in the root of the uberspace. |
0 commit comments