update readme

pablo-sch · pablo-sch · commit 66c47d874b73 · 2025-07-18T18:46:58.000+02:00
diff --git a/docs/README.de.md b/docs/README.de.md
@@ -1,12 +1,8 @@
 # Test-Driven-Development-Übung mit JavaScript
 
-**KeepCoding Projects - Web 18**  
-Detaillierte Liste der Repositories und Beschreibungen in 📁 [repos-kc-web-18.md](https://github.com/pablo-sch/pablo-sch/blob/main/docs/repos-kc-web-18.md)
+`>` **KeepCoding Projekte - Web 18:** 📁 [repos-kc-web-18.md](https://github.com/pablo-sch/pablo-sch/blob/main/docs/repos-kc-web-18.md)
 
-## Wähle deine Sprache
-
-- 🇺🇸 [Englisch](README.md)
-- 🇪🇸 [Spanisch](README.es.md)
+`>` **Wähle deine Sprache:** [Englisch](README.md) 🔄 [Spanish](README.es.md)
 
 <!-- ------------------------------------------------------------------------------------------- -->
 
@@ -25,15 +21,18 @@ Tests sind unerlässlich, um Fehler vor dem Deployment zu erkennen, Vertrauen in
 ### Testarten
 
 #### 1. Externe Tests (End-to-End)
+
 - Manuell: Ein Tester überprüft das Verhalten der Anwendung visuell anhand vordefinierter Schritte.
 - Automatisiert: Simulieren Benutzerinteraktionen, um das Verhalten nach Codeänderungen zu validieren.
 
 #### 2. Funktionale Tests
+
 - Unit-Tests: Testen einzelne Funktionen oder Module isoliert.
 - Integrationstests: Prüfen das Zusammenspiel mehrerer Komponenten.
 - End-to-End: Simulieren vollständige Nutzerabläufe, um die Gesamtfunktionalität der Anwendung sicherzustellen.
 
 #### 3. Nicht-funktionale Tests
+
 - Sicherheit: Erkennen Schwachstellen und prüfen den Schutz sensibler Daten.
 - Leistung: Messen Antwortzeiten und Verhalten unter Last.
 - Benutzerfreundlichkeit: Analysieren die reale Nutzererfahrung in der Oberfläche.
@@ -63,45 +62,49 @@ TODO
 
 ## Verwendete Technologien
 
-### Sprachen
-
-- **JavaScript**: Um der Website Interaktivität und dynamische Funktionen hinzuzufügen, wodurch die Benutzererfahrung durch Funktionen wie Formularvalidierung, Animationen und Event-Handling verbessert wird.
-
-### Abhängigkeiten
-
-- babel
-- jest
-- axios
+- **Sprachen:** JavaScript.
+- **Bemerkenswerte Abhängigkeiten (Node.js):** Babel, Jest und Axios.
 
 <!-- ------------------------------------------------------------------------------------------- -->
 
-## Installations- und Gebrauchsanweisungen
+## Installations- und Nutzungshinweise
 
-### Softwareanforderungen
+### 1. Softwareanforderungen
 
+- **[Node.js](https://nodejs.org/en/download/)** (getestet mit Version **v22.15.1**)
 - **[Git](https://git-scm.com/downloads)** (getestet mit Version **2.47.1.windows.1**)
 - **[Visual Studio Code](https://code.visualstudio.com/)** (getestet mit Version **1.99.0**)
 
-### Klonen des Repositories
-
-Projekt
+### 2. Repository-Klonen
 
 ```bash
-`git clone https://github.com/pablo-sch/keepcoding-09-TDD-with-javascript.git`
+git clone https://github.com/pablo-sch/keepcoding-09-TDD-with-javascript.git
 ```
 
-Demo
+`>` **Klon-Demo in VSCode ansehen:** 🎥 [Gif Demo](https://github.com/pablo-sch/pablo-sch/blob/main/etc/clone-tutorial.gif)
 
-![Demo](https://github.com/pablo-sch/pablo-sch/blob/main/etc/clone-tutorial.gif)
+### 3. Befehle
 
-<!-- ------------------------------------------------------------------------------------------- -->
+```sh
+# Installiere die Projektabhängigkeiten.
+npm install
 
-## Projektvorschau
+# Führe Tests einmalig mit Jest aus.
+npm test
 
-Keine
+# Führe Tests im Beobachtungsmodus aus, nur betroffene Tests.
+npm test:watch
 
-<!-- ------------------------------------------------------------------------------------------- -->
+# Führe alle Tests im Beobachtungsmodus aus.
+npm test:watchAll
+
+# Zeige die Liste der Testdateien an.
+npm test:list
+
+# Führe Tests aus und zeige Ergebnisse im JSON-Format.
+npm test:json
+```
 
-## Beiträge und Lizenzen
+## Beiträge und Lizenzierung
 
-Dieses Projekt enthält keine externen Beiträge oder Lizenzen.
+Projekt unter MIT-Lizenz. Frei zur Nutzung und Verbreitung mit Namensnennung. Externe Beiträge werden nicht akzeptiert, aber Vorschläge sind willkommen.
diff --git a/docs/README.es.md b/docs/README.es.md
@@ -1,12 +1,8 @@
 # Ejercicio de Test-Driven Development con JavaScript
 
-**Proyectos KeepCoding - Web 18**  
-Consulta la lista completa de repositorios y descripciones en 📁 [repos-kc-web-18.md](https://github.com/pablo-sch/pablo-sch/blob/main/docs/repos-kc-web-18.md)
+`>` **Proyectos KeepCoding - Web 18:** 📁 [repos-kc-web-18.md](https://github.com/pablo-sch/pablo-sch/blob/main/docs/repos-kc-web-18.md)
 
-## Selecciona tu idioma
-
-- 🇺🇸 [Inglés](README.md)
-- 🇩🇪 [Alemán](README.de.md)
+`>` **Selecciona tu Idioma:** [Inglés](README.md) 🔄 [Alemán](README.de.md)
 
 <!-- ------------------------------------------------------------------------------------------- -->
 
@@ -25,15 +21,18 @@ Las pruebas son fundamentales para detectar errores antes del despliegue, aument
 ### Tipos de Pruebas
 
 #### 1. Pruebas Externas (End-to-End)
+
 - Manuales: El tester verifica visualmente el comportamiento de la aplicación siguiendo pasos definidos.
 - Automáticas: Simulan interacciones del usuario para validar el funcionamiento tras cambios de código.
 
 #### 2. Pruebas Funcionales
+
 - Unitarias: Evalúan funciones o módulos individuales de forma aislada.
 - De integración: Comprueban que múltiples componentes funcionen correctamente en conjunto.
 - End-to-End: Simulan flujos completos del usuario para garantizar el correcto funcionamiento de la aplicación.
 
 #### 3. Pruebas No Funcionales
+
 - Seguridad: Detectan vulnerabilidades y validan la protección de datos sensibles.
 - Rendimiento: Evalúan tiempos de respuesta y comportamiento bajo carga.
 - Usabilidad: Analizan la experiencia real del usuario en la interfaz.
@@ -63,45 +62,49 @@ TODO
 
 ## Tecnologías utilizadas
 
-### Lenguajes
-
-- **JavaScript**: para agregar interactividad y características dinámicas al sitio web, mejorando la experiencia del usuario con funcionalidades como validación de formularios, animaciones y manejo de eventos.
-
-### Dependencias
-
-- babel
-- jest
-- axios
+- **Lenguajes:** JavaScript.
+- **Dependencias a destacar (Node.js):** Babel, Jest y Axios.
 
 <!-- ------------------------------------------------------------------------------------------- -->
 
 ## Instrucciones de instalación y uso
 
-### Requisitos de software
+### 1. Requisitos de Software
 
+- **[Node.js](https://nodejs.org/en/download/)** (testeado en la versión **v22.15.1**)
 - **[Git](https://git-scm.com/downloads)** (testeado en la versión **2.47.1.windows.1**)
 - **[Visual Studio Code](https://code.visualstudio.com/)** (testeado en la versión **1.99.0**)
 
-### Clonación del repositorio
-
-Proyecto
+### 2. Clonación del Repositorio
 
 ```bash
-`git clone https://github.com/pablo-sch/keepcoding-09-TDD-with-javascript.git`
+git clone https://github.com/pablo-sch/keepcoding-09-TDD-with-javascript.git
 ```
 
-Demo
+`>` **Ver Demo de Clonanción en VSCode:** 🎥 [Gif Demo](https://github.com/pablo-sch/pablo-sch/blob/main/etc/clone-tutorial.gif)
 
-![Demo](https://github.com/pablo-sch/pablo-sch/blob/main/etc/clone-tutorial.gif)
+### 3. Comandos
 
-<!-- ------------------------------------------------------------------------------------------- -->
+```sh
+# Instala las dependencias del proyecto.
+npm install
 
-## Vista previa del proyecto
+# Ejecuta las pruebas con Jest una vez.
+npm test
 
-Ninguna
+# Ejecuta las pruebas en modo observación, corre solo las afectadas.
+npm test:watch
 
-<!-- ------------------------------------------------------------------------------------------- -->
+# Ejecuta todas las pruebas en modo observación.
+npm test:watchAll
+
+# Muestra la lista de archivos de prueba.
+npm test:list
+
+# Ejecuta las pruebas y muestra el resultado en formato JSON.
+npm test:json
+```
 
 ## Contribuciones y licencias
 
-Este proyecto no cuenta con contribuciones externas ni licencias.
+Proyecto bajo licencia MIT. Uso y distribución libres con atribución. No se aceptan contribuciones externas, pero las sugerencias son bienvenidas.
diff --git a/docs/README.md b/docs/README.md
@@ -1,12 +1,8 @@
 # Test-Driven Development Exercise with JavaScript
 
-**KeepCoding Projects - Web 18**  
-Check the full list of repositories and descriptions in 📁 [repos-kc-web-18.md](https://github.com/pablo-sch/pablo-sch/blob/main/docs/repos-kc-web-18.md)
+`>` **KeepCoding Projects - Web 18:** 📁 [repos-kc-web-18.md](https://github.com/pablo-sch/pablo-sch/blob/main/docs/repos-kc-web-18.md)
 
-## Select your language
-
-- 🇪🇸 [Spanish](README.es.md)
-- 🇩🇪 [German](README.de.md)
+`>` **Select your Language:** [Spanish](README.es.md) 🔄 [German](README.de.md)
 
 <!-- ------------------------------------------------------------------------------------------- -->
 
@@ -25,15 +21,18 @@ Testing is essential to detect bugs before deployment, increase confidence in th
 ### Types of Tests
 
 #### 1. External Tests (End-to-End)
+
 - Manual: A tester visually verifies the application's behavior following predefined steps.
 - Automated: Simulate user interactions to validate behavior after code changes.
 
 #### 2. Functional Tests
+
 - Unit: Evaluate individual functions or modules in isolation.
 - Integration: Check that multiple components work correctly together.
 - End-to-End: Simulate complete user flows to ensure the application functions as expected.
 
 #### 3. Non-Functional Tests
+
 - Security: Detect vulnerabilities and validate the protection of sensitive data.
 - Performance: Evaluate response times and behavior under load.
 - Usability: Analyze real user experience within the interface.
@@ -63,45 +62,49 @@ TODO
 
 ## Technologies Used
 
-### Languages
-
-- **JavaScript**: To add interactivity and dynamic features to the website, improving the user experience with functionalities such as form validation, animations, and event handling.
-
-### Dependencies
-
-- babel
-- jest
-- axios
+- **Languages:** JavaScript.
+- **Notable Dependencies (Node.js):** Babel, Jest, and Axios.
 
 <!-- ------------------------------------------------------------------------------------------- -->
 
 ## Installation and Usage Instructions
 
-### Software Requirements
+### 1. Software Requirements
 
+- **[Node.js](https://nodejs.org/en/download/)** (tested on version **v22.15.1**)
 - **[Git](https://git-scm.com/downloads)** (tested on version **2.47.1.windows.1**)
 - **[Visual Studio Code](https://code.visualstudio.com/)** (tested on version **1.99.0**)
 
-### Cloning the Repository
-
-Proyect
+### 2. Repository Cloning
 
 ```bash
-`git clone https://github.com/pablo-sch/keepcoding-09-TDD-with-javascript.git`
+git clone https://github.com/pablo-sch/keepcoding-09-TDD-with-javascript.git
 ```
 
-Demo
+`>` **View Cloning Demo in VSCode:** 🎥 [Gif Demo](https://github.com/pablo-sch/pablo-sch/blob/main/etc/clone-tutorial.gif)
 
-![Demo](https://github.com/pablo-sch/pablo-sch/blob/main/etc/clone-tutorial.gif)
+### 3. Commands
 
-<!-- ------------------------------------------------------------------------------------------- -->
+```sh
+# Install project dependencies.
+npm install
 
-## Project Preview
+# Run tests once with Jest.
+npm test
 
-None
+# Run tests in watch mode, only affected tests.
+npm test:watch
 
-<!-- ------------------------------------------------------------------------------------------- -->
+# Run all tests in watch mode.
+npm test:watchAll
+
+# Show the list of test files.
+npm test:list
+
+# Run tests and output results in JSON format.
+npm test:json
+```
 
 ## Contributions and Licensing
 
-This project does not include external contributions or licenses.
+Project licensed under the MIT License. Free to use and distribute with attribution. External contributions are not accepted, but suggestions are welcome.
diff --git a/package.json b/package.json
@@ -37,5 +37,9 @@
   },
   "dependencies": {
     "axios": "^1.9.0"
+  },
+  "engines": {
+    "node": ">=22.15.1",
+    "npm": ">=11.4.0"
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -37,5 +37,9 @@`
`37`	`37`	`},`
`38`	`38`	`"dependencies": {`
`39`	`39`	`"axios": "^1.9.0"`
	`40`	`+ },`
	`41`	`+ "engines": {`
	`42`	`+ "node": ">=22.15.1",`
	`43`	`+ "npm": ">=11.4.0"`
`40`	`44`	`}`
`41`	`45`	`}`