Readme angepasst

master
David Heidl 2023-06-14 06:09:14 +02:00
parent 0d3fb9f24f
commit beb3d78eec
2 changed files with 27 additions and 58 deletions

View File

@ -1,70 +1,41 @@
# Getting Started with Create React App
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
## Available Scripts
# THW GAT
## Die Trainer-App für die THW Grundausbildung
In the project directory, you can run:
Die Webapp bietet den Nutzern die Möglichkeit alle Theoriefragen für die Grundausbildungsprüfung vorab schrittweise durchzugehen oder eine Prüfung zu simulieren. Auch das Lernen der einzelnen Kategorien ist möglich. Die App speichert im normalen Modus den Fortschritt, so dass man immer da weitermachen kann, wo man aufgehört hat.
### `npm start`
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
## Verwendung
The page will reload when you make changes.\
You may also see any lint errors in the console.
Auf der Startseite kann der Nutzer auswählen, wie er die Fragen lernen möchte. Hierfür stehen ihm drei Trainingsmodi zur Verfügung:
- Prüfungsmodus: Hier kann der Nutzer eine Prüfung mit 40 zufälligen Fragen simulieren
- Zufällige Fragen: Das ist der normale Modus zum Lernen aller Fragen (Der Fortschritt bleibt)
- Fragen nach Kategorie: Hier kann man eine Kategorie auswählen und bekommt dann nur die jeweiligen Fragen angezeigt
### `npm test`
Für jede Frage kann der Nutzer mindestens eine oder mehrere der drei Antwortmöglichkeiten anklicken und dann zur Korrektur seiner Angaben auf "Lösung anzeigen" (bzw. "Auflösen" im Prüfungsmodus) klicken. Die Frage wird dann dementsprechend grün oder rot markiert, je nachdem ob die Frage richtig beantwortet wurde oder nicht. Unter der jeweiligen Antwort steht bei fehlerhafter Angabe, was die richtige Antwort gewesen wäre.
Durch Klick auf "Weiter" wird die nächste Frage angezeigt.
Im Trainingsmodus kann der Nutzer über einen Klick auf "Info" weitere Infos zu der Frage und dem Trainingsfortschritt erfahren. Hier kann im Modus "Zufällige Fragen" auch der Fortschritt zurückgesetzt werden.
Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
### `npm run build`
## Weiterführende Informationen
Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
### Zur App
The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!
Die App ist auf Basis von React entwickelt worden und nach einem Designthema der ToNetwork UG entworfen worden. Sie ist sowohl auf dem Desktop als auch auf mobilen Geräten im Browser verfügbar.
Sie wird auf einem deutschen Server gehosted und speichert abgesehen von den typischerweise anfallenden technischen Daten beim Aufruf einer Webseite keine weiteren Daten.
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
### Rechtliches
Die App wurde von der ToNetwork UG entwickelt und wird von dieser frei für alle Teilnehmer der Grundausbildung zum Üben der Fragen auf "thw-gat.de" Verfügung gestellt. Eine Weiterverwendung oder (kommerzielle) Nutzung des Codes ist nicht gestattet. Die enthaltenen Fragen sind geistiges Eigentum der Bundesanstalt Technisches Hilfswerk.
Entwickler: David Adrian Heidl (ToNetwork UG)
Email-Kontakt: info@tonetwork.de
Weitere Informationen und Kontaktmöglichkeiten bei Problemen oder Anregungen: https://tonetwork.de
### `npm run eject`
**Note: this is a one-way operation. Once you `eject`, you can't go back!**
If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
## Learn More
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
To learn React, check out the [React documentation](https://reactjs.org/).
### Code Splitting
This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
### Analyzing the Bundle Size
This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
### Making a Progressive Web App
This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
### Advanced Configuration
This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
### Deployment
This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
### `npm run build` fails to minify
This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
### Verfügbare Skripte der React-App
- `npm start`
Für die Ansicht im Browser: [http://localhost:3000](http://localhost:3000)
- `npm test`
Führt die React-App im Testmodus aus
- `npm run build`
Erstellt einen Produktionsbuild

2
readme
View File

@ -1,2 +0,0 @@
#THW-GAT Projekt
->Homepage