Merge pull request #41 from FEUP-ESOF-2020-21/sprint-4-review

Sprint 4 review

docs/README.md

@@ -404,10 +404,10 @@ Scenario:
 
 ![Domain Model Diagram](./img/domain-model.png)
 
-The concepts regarding our application are quite simple. Our app consist about conferences spread around the world and the users have filter tools at their disposal to find the more relevant conferences to them. Each one of this `conference` is represented on the world map by a `Marker`.
+The concepts regarding our application are quite simple. Our app consists of conferences spread around the World `Map` and the user has filtering tools at his disposal that allow him to find the most fitting conferences. Each `Conference` is represented on the world map by a `Marker`.
 
-After the user opened the `Map`, it will render on a certain `latitude` and `longitude` and have some `Markers`, where each one represents one `Conference`. 
-Also, the user can just look for specific conferences. In this case, he will apply a `Filter` to the world map, but just one filter can be applied for the whole map at a time. The user can see the map without filters, seeing all the available conferences, or instead the user can filter by `Date`, for `Saved` conferences or by `Type`, but just one at time.
+Once the user has opened the `Map`, it will render on a certain `latitude` and `longitude`, have some `Markers`, and each one represents one `Conference`. 
+Also, the user can just look for specific conferences. In this case, he will apply a `Filter` to the world map, but just one filter can be applied for the whole map at a time. The user can see the map without filters, seeing all the available conferences, or instead the user can filter by `Date`, by `Saved` conferences or by `Type`, but just one at a time.
 
 ---
 
@@ -420,15 +420,19 @@ The architeture models of a big project can help newcomers to understand it bett
 
 In order to develop this project, we decided to organize and structure our code using the MVC. The code is divided into three different packages: 
 
+
+* Controller
 * View
 * Model
-* Controller
 
-Our View is responsible for the concrete display of the app to the user. It renders our widgets and different pages, like homepage on the smartphone screen.
 
-The Model contains all the application data. It has the color schemes, button text and other data fields that will be displayed on View.
+The Controller processes the received information from user actions. These actions triggers changes both in the view (for example, changing the the current screen displayed) and in the model (for example, when the user saves a conference).
+
+Our View is responsible for the concrete display of the app to the user. It renders our widgets and different pages, like the homepage on the smartphone screen.
+
+The Model contains all the application data. It represents stored entities managed by the controller, such as a Conference.
+
 
-The Controller processes the received information from user actions. This actions triggers changes both in the view (for example, changing the the current screen displayed) and in the model (for example, when the user saves a conference).
 
 ### Physical architecture
 
@@ -504,7 +508,7 @@ Sprint Effort: L
 
 To ensure the application is working properly, we have decided to add Unit Tests and automated acceptance tests using gherkin.
 
-We used the [github issues](https://github.com/FEUP-ESOF-2020-21/open-cx-t2g1-2b-2b/issues?q=is%3Aopen+is%3Aissue) to organize our project. If you want to see our implementation of user stories you can click [here](https://github.com/FEUP-ESOF-2020-21/open-cx-t2g1-2b-2b/issues?q=is%3Aissue+label%3A%22user+stories%22+is%3Aclosed) and see the issues that map for every user story.
+We used the [github issues](https://github.com/FEUP-ESOF-2020-21/open-cx-t2g1-2b-2b/issues?q=is%3Aissue+is%3Aclosed+label%3A%22Unit+Tests%22) to organize our project. If you want to see our implementation of user stories you can click [here](https://github.com/FEUP-ESOF-2020-21/open-cx-t2g1-2b-2b/issues?q=is%3Aissue+label%3A%22user+stories%22+is%3Aclosed) and see the issues that map for every user story.
 
 Unit Tests are used to verify the expected output after the user interacts with the application and have been implemented using the `flutter_test` dependency.
 
@@ -513,14 +517,17 @@ Acceptance Tests are used to verify the expected output through statements that
 Both these tests involve a large ammount of work, however, they provide a long-term benefit to the project, making it easier to detect bugs in the future.
 
 Implemented acceptance tests:
-  - Conference Details - [User Story ](https://github.com/FEUP-ESOF-2020-21/open-cx-t2g1-2b-2b/issues/4)
+  - Conference Details - [User Story 3](https://github.com/FEUP-ESOF-2020-21/open-cx-t2g1-2b-2b/issues/4)
   - Filter Conferences By Type - [User Story 5](https://github.com/FEUP-ESOF-2020-21/open-cx-t2g1-2b-2b/issues/5)
   - Open World Map - [User Story 1](https://github.com/FEUP-ESOF-2020-21/open-cx-t2g1-2b-2b/issues/1)
 
 Implemented Unit Tests:
   - See World Map
+  - See Saved Conferences
   - Filter Conferences Button
   - Filter Conferences by Type
+  - Filter Conferences by Date
+  - Filter Conferences by Saved Conferences
   - See World Map Without Filters
   - Default Navigation State
   - Navigation between States 
@@ -532,7 +539,7 @@ There are still many tests that can be tested in the future. The planned feature
 - Saved Conferences local database persistent data storage.
 - Pressing a Conference in Saved Conferences Menu redirects to the world map with the chosen conference centered.
 
-We're actually running this tests automatically on [github actions](https://github.com/FEUP-ESOF-2020-21/open-cx-t2g1-2b-2b/actions). However the pipeline running the gherkin acceptance tests are not running because they need a emulator to have a successfully run.
+We're actually running this tests automatically on [github actions](https://github.com/FEUP-ESOF-2020-21/open-cx-t2g1-2b-2b/actions). However the pipeline running the gherkin acceptance tests are not running because they need an emulator to have a successfully run.
 
 ---
 ## Configuration and change management