UML Use-Case diagram, Site Map and URL Table

Author: ogarmpis

docs/README.md

@@ -2,10 +2,11 @@
 
 ## Software Analysis
 - [Requirements Specification](./specs/requirements_specification.md)
-- [Site Map](./specs/site_map.md)
+- [URL Table](./specs/url_table.md)
 - [REST API](./specs/rest_api.md)
 
-## Design Diagrams
+## Diagrams
 - [Database ER Diagram](./database/Database_PostgreSQL_ER_Diagram.png)
-- [UML Diagram](./uml/UMLphoto.jpg)
-- [Wireframes](./wireframes/wireframes_diagram.md)
+- [Site Map](./design/site_map.png)
+- [UML Use Case Diagram](./design/UML_Use-Case_Diagram.png)
+- [Wireframes](./design/wireframes_diagram.md)

docs/design/UML_Use-Case_Diagram.png

@@ -0,0 +1,44 @@
+## DEVils-Scrum-Tool Wireframes
+These wireframes show the platform's pages as originally designed by our team. Even though some changes have been made during development, more or less are the same both visually and functionally.
+
+### Index Page
+![Index Wireframe](./wireframes/Index%20Page.png)
+
+### Sign Up Page
+![Sign up Wireframe](./wireframes/Sign%20up%20page.png)
+
+### Sign In Page
+![Sign in Wireframe](./wireframes/Sign%20In%20Page.png)
+
+### Forgot Password Page
+![Forgot Password Wireframe](./wireframes/Forgot%20Password%20page.png)
+
+### User Homepage
+![User Homepage](./wireframes/User%20Homepage.png)
+
+### Profile Page
+![Profile Wireframe](./wireframes/Profile%20Page.png)
+
+### Edit Profile Page
+![Edit Profile Wireframe](./wireframes/Edit%20Profile%20Page.png)
+
+### Change Password Page
+![Change Password Wireframe](./wireframes/Change%20Password%20Page.png)
+
+### Project Page - Overview Current Sprint
+![Project Page - Overview](./wireframes/Project%20Page%20-%20Overview.png)
+
+### Project Page - Overview Finished Sprint
+![Project Page - Finished Sprint](./wireframes/Project%20Page%20-%20Finished%20sprint.png)
+
+### Product Backlog Page
+![Product Backlog](./wireframes/Project%20Page%20-%20Backlog.png)
+
+### Old Sprints Page
+![Previous Sprints' Page](./wireframes/Project%20Page%20-%20Previous%20Sprints.png)
+
+### Create New Sprint
+![Create New Sprint](./wireframes/Project%20Page%20-%20Create%20new%20sprint.png)
+
+### Sprint Backlog Page
+![Sprint Page Overview](./wireframes/Sprint%20Page%20Overview.png)

docs/design/site_map.png

@@ -54,6 +54,7 @@
 | 43 | Delete Issue | All users | On the bottom right of the edit issue modal (#42), a button named "Delete Issue" is located. Click it and this issue will be deleted from this task's list of issues. This has to be the best action of every developer using this application!!! |
 | 44 | Go back to Homepage (#11) | All users | Click the "DEVils-Scrum-Tool" logo on the top left of the navigation bar. |
 
+
 ## Non-Functional Requirements
 
 | # | Category | Title | Description |
@@ -72,12 +73,13 @@
 | 12 | Usability | Minimalistic Design | The user interface follows minimalistic design: 1. The interface is easy to get used to. 2. Lots of text is avoided. 3. Easy and straightforward navigation between main pages. |
 | 13 | Maintainability | Modularity | The code is built in modules, so that independent parts accomplish independent tasks. This is accomplished through the use of spring boot framework on back-end, while lots of components have been implemented on front-end, using Vuejs. |
 | 14 | Maintainability | Layered Application Design | Application consists of different layers like Presentation Layer (front-end, Vuejs), Business Layer (back-end, Spring Boot) and Data Layer (JPA-Hibernate on a PostgreSQL Database). (3-Tier) |
-| 15 | Testability | Unit & Integration Testing | Both on front-end (Jest) and back-end (JUnit & Mockito) testing is implemented. On back-end, integration tests are implemented using an In-Memory embedded database with preloaded data. |
+| 15 | Testability | Unit & Integration Testing | Both on front-end (Jest) and back-end (AssertJ & Mockito) testing is implemented. On back-end, integration tests are implemented using an In-Memory embedded database with preloaded data. |
 | 16 | Reliability | Free of Bugs with Safe Operations | During development, extensive testing and fixes on bugs have taken place, so as we are convinced that there will not be any problems during application usage. Moreover, a special care has been given on safe database operations, as use of transactions and foreign keys eliminate the possibility of a fatal data error. |
 | 17 | Performance | AJAX Calls | AJAX-based asynchronous model is used for client - server communication, minimizing the pages reloads. |
-| 18 | Portability | Environment Independence | The prerequisites that the application needs to run is Java 11 for back-end and nodejs for front-end, as a result, a great portability is secured. Moreover, by using docker, our application's portability is even more extensive, as there are Dockerfiles (along with instructions) to deploy front-end, back-end and database into independent containers. |
-| 19 | Extensibility | RESTful Architecture | A RESTful API has been created (and documented), which could be used in a future extension of our platform to a mobile application (Android, IOS) without many changes. |
-| 20 | Extensibility | Documentation | A complete documentation comes with this application, which helps developers to understand and develop even more the application's code. Design diagrams, Requirements Specification, Site Map and REST API are provided along with source code. |
-| 21 | Deployment | Deploy on (remote) server | The application is deployed for production in Heroku. For development an embedded Tomcat server (coming with Spring Boot) is used, while also containerization is another available option, with the use of docker. Both files and deploying instructions are given in client and server README files. |
-| 22 | Availability | Percentage of Accessibility | As this application is deployed on a free (hobby) Heroku host, the availability is not the best possible. Heroku servers go to idle 20 minutes after the last AJAX request, so it will be a bit slow on the first access. Also there is usual database maintenance, so the server may be off for some minutes. |
-| 23 | Cost | Total Free!! | It is strongly suggested that if a developers team wants to use this application, to fork it and deploy it on their own Heroku account, using a hobby account. In this way, not only they will have their private online tool, with no other users (improving the performance), but also use a simple yet powerful open source Scrum tool application totally FREE OF CHARGE!! |
+| 18 | Performance | Pagination | On index page, the project that user participates in are presented (both current and done). To avoid loading all projects together, pagination is used, as both current and done projects are retrieved from database by groups of 4 each time by increasing deadline order (depending on the page loaded each time). |
+| 19 | Portability | Environment Independence | The prerequisites that the application needs to run is Java 11 for back-end and nodejs for front-end, as a result, a great portability is secured. Moreover, by using docker, our application's portability is even more extensive, as there are Dockerfiles (along with instructions) to deploy front-end, back-end and database into independent containers. |
+| 20 | Extensibility | RESTful Architecture | A RESTful API has been created (and documented), which could be used in a future extension of our platform to a mobile application (Android, IOS) without many changes. |
+| 21 | Extensibility | Documentation | A complete documentation comes with this application, which helps developers to understand and develop even more the application's code. Design diagrams, Requirements Specification, Site Map and REST API are provided along with source code. |
+| 22 | Deployment | Deploy on (remote) server | The application is deployed for production in Heroku. For development an embedded Tomcat server (coming with Spring Boot) is used, while also containerization is another available option, with the use of docker. Both files and deploying instructions are given in client and server README files. |
+| 23 | Availability | Percentage of Accessibility | As this application is deployed on a free (hobby) Heroku host, the availability is not the best possible. Heroku servers go to idle 20 minutes after the last AJAX request, so it will be a bit slow on the first access. Also there is usual database maintenance, so the server may be off for some minutes. |
+| 24 | Cost | TOTAL FREE!! | It is strongly suggested that if a developers team wants to use this application, to fork it and deploy it on their own Heroku account, using a hobby account. In this way, not only they will have their private online tool, with no other users (improving the performance), but also use a simple yet powerful open source Scrum tool application totally FREE OF CHARGE!! |

docs/wireframes/Change Password Page.png docs/design/wireframes/Change Password Page.png

@@ -0,0 +1,21 @@
+# DEVils-Scrum-Tool Web Pages URL Table
+This table contains all the pages that this platform contains, along with their URLs, the Vue components that represent them, if they are working with a logged in user (or not) and a brief description.
+
+## URL Table
+
+| URL | Component (Vue.js) | Authorized User | Description |
+|-|:-:|:-:|-|
+| / | IndexDefault | No | The default Index page of application, when the user is not logged in. Basic information about the app are provided here. |
+| /signup | SignUp | No | A from with signup credentials lies in this page. When user has fill them and press "Sign Up", he/she is redirected to Index page as a logged in user. |
+| /signin | SignIn | No | Log In page, where user fill in his/her email and password to insert into the application. |
+| /forgotpass | ForgotPass | No | If the user has forgotten the password, he is supposed to retrieve it by a link to his/her email. This function is NOT IMPLEMENTED! |
+| / | Index | Yes | The index page of DEVils-Scrum-Tool when the user is logged in. All the projects that user participates in are presented here, along with the ability to create new ones. |
+| /users/{username} | Profile | Yes | A card with basic profile information about the user with attached (in URL) username. This can be either the logged in user's profile, or some other one's. |
+| /editprofile | EditProfile | Yes | User can edit his profile information, change his password or delete his account. |
+| /project/{projectId}/overview | ProjectPageOverview | Yes | The overview of the selected project (with id = projectId), showing the project's info, its current sprint's information, along with the team members. |
+| /project/{projectId}/backlog | Backlog | Yes | The product backlog page. A user can create/edit/delete epics and user stories in this page. |
+| /project/{projectId}/sprints | OldSprints | Yes | A list with all sprints of this project lies in this page. |
+| /project/{projectId}/newsprint | NewSprint | Yes | A form to create a new current sprint. Along with sprint's information, a user can add user stories in this sprint before its creation. |
+| /project/{projectId}/sprintbacklog/{sprintId} | SprintBacklog | Yes | The core of this application, with a big kanban board, in which user can add/edit/move/delete tasks and issues that are attached to a user story. Also he/she can add user stories in the sprint backlog, and update the sprint's information. |
+| /unauthorized | Unauthorized | - | If a user attempts (with a hardcoded URL) to access a page where he/she has no right to (e.g a non-logged in user to a user's profile, or an authorized one to a project which has no access to, then the application redirects in this page by default. |
+| * | PageNotFound | - | Whenever an invalid URL is provided (anything else than the above URLs), the application redirects to this default page. |

docs/wireframes/Edit Profile Page.png docs/design/wireframes/Edit Profile Page.png

@@ -32,7 +32,7 @@ Check it on http://localhost:8765/api/hello (Message: "Greetings from Spring Boo
 ### Build (without time-consuming tests)
 	./gradlew build -x test
 
-### Spring Boot Integration Testing (JUnit5 & Mockito)
+### Spring Boot Integration Testing (AssertJ & Mockito)
 	./gradlew test
 
 ### Format the code