Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated documentation and README #226

Merged
merged 5 commits into from
Apr 28, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Some changes to the documentation and started adding the deployment i…
…nstructions to the README.md
  • Loading branch information
uo287545 committed Apr 27, 2024
commit a096887fb772d45a644a8dced0868e0169460e71
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,10 @@
- **Ricardo Díaz Núñez**
- **Roberto Peña Goy**
- **Iker Álvarez Fernández**

### Local deployment instructions

1. Fist you have to execute in the CMD the following command to clone the repository: `git clone https://github.com/Arquisoft/wiq_es04b.git`

2. First you have to execute the [runServer.bat](https://github.com/Arquisoft/wiq_es04b/blob/master/database/hsqldb/bin/runServer.bat).
3. With the database initialized you have to ope
2 changes: 1 addition & 1 deletion docs/src/01_introduction_and_goals.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The overall goal of the application is to provide a fun and challenging experien
=== Quality Goals
[options="header",cols="1,2,2"]
|===
|Nº|Atributo|Motivacion
|Nº|Quality Goal|Motivation
| 1 | Efficiency | Access, creation of questions, and navigation between them should be fast to ensure user satisfaction.
| 2 | Usability | The application should be appealing to all fans of the original program while also offering a wide variety of questions.
| 3 | Manteinance | The application should ensure easy expansion and modification to provide users with new features.
Expand Down
4 changes: 3 additions & 1 deletion docs/src/14_testing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,7 @@ To be able to achieve continuous delivery, we need to have a good test coverage.
In our project, we have implemented unit tests for various components of the application. The tests are written in Java and use the JUnit 5 framework for testing. We also use the Spring Boot Test framework for testing Spring Boot applications, which provides utilities and annotations to test the application in a way that is very close to its actual runtime behavior. The tests are located in the src/test/java/com/uniovi directory. The main test class is Wiq_UnitTests.java, which contains tests for various services and repositories in our application.

=== Integration Test (E2E)
All the cucumber files are located in the src/test/resources/features directory. We've implemented all the cucumber steps in the src/test/java/com/uniovi/steps directory. The main test class is Wiq_IntegrationTests.java in src/test/java/com/uniovi, which you should run to execute the integration tests.

=== Load Test
=== Load Test
We've used Gatling to test how much load our application can handle.