README.md

 # Pokemon Trainer Database
 
-The [Pokemon Trainer Database](https://gitlab.utwente.nl/claudenirmf/mod4-wp-2023-2024-pokemon) is a sample web
+The [PokeApp](https://gitlab.utwente.nl/claudenirmf/mod4-wp-2023-2024-pokemon) is a sample web
 application designed to teach web development concepts at
 the [Data & Information module](https://www.utwente.nl/en/education/bachelor/programmes/technical-computer-science/study-programme/#modules-technical-computer-science)
 of the [Technical Computer Science](https://www.utwente.nl/en/education/bachelor/programmes/technical-computer-science/)
@@ -10,13 +10,16 @@ The contents of this repository are licensed
 under [Creative Commons Attribution 4.0 International (CC-BY-4.0)](./LICENSE). Viewers are welcome to reuse its contents
 and to submit their own contributions.
 
-## Repository structure
+![](./design/models/Class%20Diagram.png)
 
-- `/`:
+**NOTE: this diagram has been simplified in the implementation and several fields have been omitted.**
 
-## Class Diagram
+## Support files
 
-## External resources
+- `/design`: this folder different files to support the design of the PokeApp including an [OpenAPI specification](./design/open-api.yaml) containing all routes and various [HTTP request files](./design/requests) to be executed directly from IntelliJ's HTTP client.
+- `./meetings/practical-session-3.md`: [this file](./meetings/practical-session-3.md) contains different guides and tips to help you work on the practical session (e.g., how to checkout a new remote branch, or how to run HTTP requests).
+
+## Credits
 
 The following datasets and resources have been used in the development this project.
 
@@ -34,3 +37,5 @@ The following datasets and resources have been used in the development this proj
     - GitHub: [@claudenirmf](https://github.com/claudenirmf)
     - LinkedIn: [@claudenir-fonseca](https://www.linkedin.com/in/claudenir-fonseca/)
     - E-mail: [c.moraisfonseca@utwente.nl](c.moraisfonseca@utwente.nl)
+
+Additional contributions are welcome in the forms of issues and merge requests.

design/example-open-api.yaml

+openapi: 3.0.3
+info:
+  title: Example OpenAPI document
+  description: Example OpenAPI document
+  version: 1.0.0
+servers:
+  - url: 'https://example.com'
+paths:
+  '/api/pokemon':
+      get:
+        description: Retrieves pokemon resources.
+        responses:
+          200:
+            description: OK
\ No newline at end of file

design/requests/requests-pokemon-types.http

+###
+GET http://localhost:8080/pokemon/api/pokemonTypes
+
+###
+GET http://localhost:8080/pokemon/api/pokemonTypes?pageSize=1&pageNumber=1
+
+###
+GET http://localhost:8080/pokemon/api/pokemonTypes/1
+
+###
+POST http://localhost:8080/pokemon/api/pokemonTypes
+Content-Type: application/json
+
+{}
+
+###
+# Run this after creating a new pokemon type
+PUT http://localhost:8080/pokemon/api/pokemonTypes/802
+Content-Type: application/json
+
+{
+  "id": "802",
+  "name": "Modified Pokemon Type"
+}
+
+###
+# Run this after creating a new pokemon type
+DELETE http://localhost:8080/pokemon/api/pokemonTypes/802

design/requests/requests-pokemon.http

+###
+GET http://localhost:8080/pokemon/api/pokemon
+
+###
+# Run rhis after implementing pagination
+GET http://localhost:8080/pokemon/api/pokemon?pageSize=1&pageNumber=1
+
+###
+# Run rhis after implementing sorting
+GET http://localhost:8080/pokemon/api/pokemon?sortBy=name
+
+###
+# If you run this before creating a pokemon, it should return a 404 error
+GET http://localhost:8080/pokemon/api/pokemon/1
+
+###
+POST http://localhost:8080/pokemon/api/pokemon
+Content-Type: application/json
+
+{
+  "name": "My new pokemon",
+  "pokemonType": "1",
+  "trainerId": "1"
+}
+
+###
+# Run this after creating a new pokemon
+PUT http://localhost:8080/pokemon/api/pokemon/1
+Content-Type: application/json
+
+{
+  "id": "1",
+  "name": "My modified pokemon",
+  "pokemonType": "1",
+  "trainerId": "2"
+}
+
+###
+# Run this after creating a new pokemon
+DELETE http://localhost:8080/pokemon/api/pokemon/1

design/requests/requests-trainers.http

+###
+GET http://localhost:8080/pokemon/api/trainers
+
+###
+GET http://localhost:8080/pokemon/api/trainers?pageSize=1&pageNumber=1
+
+###
+GET http://localhost:8080/pokemon/api/trainers/1
+
+###
+POST http://localhost:8080/pokemon/api/trainers
+Content-Type: application/json
+
+{}
+
+###
+# Run this after creating a new trainer
+PUT http://localhost:8080/pokemon/api/trainers/5
+Content-Type: application/json
+
+{
+  "id": "5",
+  "name": "Ash Ketchum"
+}
+
+###
+# Run this after creating a new trainer
+DELETE http://localhost:8080/pokemon/api/trainers/5

design/system-design.md

 ## Class Diagram
 
-![](/design/models/Class%20Diagram.png)
+NOTE: this diagram has been simplified in the implementation and several fields have been omitted.
+
+![](./models/Class%20Diagram.png)

meetings/practical-session-3.md

+# Practical Session 3 - Guides and Tips
+
+## Changing the application name on Tomcat
+
+As we are using IntelliJ to build and send our application to the Tomcat server, we need to change the _Running Configurations_ in order to set the base route this application. For example, when using `/pokemon` as the base route, all other routes will be affected like `/pokemon/pokemonTypes.html` and `/pokemon/api/pokemonTypes`. To change this, please set the field _Application context_ under the tab _Deployment_ to `/pokemon`.
+
+![](./running-configurations.png)
+
+## Checkout new branch
+
+In order to retrieve the code for the exercises of the practical session, perform the step below on your git client. Here we'll be using IntelliJ's git client:
+
+1. Find or list the remote list of your git client
+
+    ![](./intellij-git-remote.png)
+
+2. Fetch from the remote repository containing the original project all updates
+
+    ![](./intellij-git-fetch-remote.png)
+
+3. Checkout the branch `practical-session-3` and start working on it
+
+    ![](./intellij-git-checkout-branch.png)
+
+4. After committing your changes, push the branch to the upstream (i.e., to your fork on GitLab)
+
+    ![](./intellij-git-push.png)
+
+5. On GitLab, open a new Merge Request
+
+Work on implementing the issues tagged as both `feature-request` and `practical-session-3`
+
+## Running HTTP request on IntelliJ
+
+With IntelliJ, you can create files ending with `.http` to write and run requests directly from the IDE. You can find sample files [here](./../design/requests) and the full documentation [here](https://www.jetbrains.com/help/idea/http-client-in-product-code-editor.html).
+
+![](./http-client.animated.gif)
+
+
+## REST API documentations with OpenAPI
+
+OpenAPI is a standard for documenting REST APIs in JSON (or YAML). On IntelliJ, you can open the [our OpenAPI specification](./../design/open-api.yaml) and check all routes implemented or to be implemented, including examples.
+
+![](./open-api.png)

pom.xml

@@ -7,7 +7,7 @@
     <groupId>nl.utwente.mod4</groupId>
     <artifactId>pokemon</artifactId>
     <version>1.0-SNAPSHOT</version>
-    <name>mod4-wp-2023-2024-pokemon</name>
+    <name>pokemon</name>
     <packaging>war</packaging>
 
     <properties>

src/main/java/nl/utwente/mod4/pokemon/InitializationListener.java

+package nl.utwente.mod4.pokemon;
+
+import jakarta.servlet.ServletContextEvent;
+import jakarta.servlet.ServletContextListener;
+import jakarta.servlet.annotation.WebListener;
+import nl.utwente.mod4.pokemon.dao.PokemonTypeDao;
+import nl.utwente.mod4.pokemon.dao.TrainerDao;
+
+import java.io.IOException;
+
+@WebListener
+public class InitializationListener implements ServletContextListener {
+    @Override
+    public void contextInitialized(ServletContextEvent sce) {
+        System.out.println("Initializing PokeApp...");
+        try {
+            PokemonTypeDao.INSTANCE.load();
+            TrainerDao.INSTANCE.load();
+        } catch (IOException e) {
+            System.err.println("Error while loading data.");
+            e.printStackTrace();
+        }
+        System.out.println("PokeApp initialized.");
+    }
+
+    @Override
+    public void contextDestroyed(ServletContextEvent sce) {
+        System.out.println("Shutting down PokeApp...");
+        try {
+            PokemonTypeDao.INSTANCE.save();
+            TrainerDao.INSTANCE.save();
+        } catch (IOException e) {
+            System.err.println("Error while saving data.");
+            e.printStackTrace();
+        }
+        System.out.println("PokeApp shutdown.");
+    }
+
+}