Skip to content

List and Status of Deliverables Milestone 3

Gamze Gülbahar edited this page Oct 27, 2019 · 6 revisions

List Of Deliverables

Team Deliverables
Android - Register Page
- Login Page
- Language selection page
- Proficiency exam page
- Exam result page
Frontend - Register Page
- Login Page
- Language selection page
- Proficiency exam page
- Exam result page
Backend - Register User Endpoint
- Login user endpoint
- Greeting endpoint
- Content endpoints
- Grading Endpoints
- Backend API documentation and swagger UI

Status and Evaluation of Deliverables

Android

Register Page

The register page in Android works as expected. Items 1.1.3.1.1. (Users shall give their email address while registering.), 1.1.3.1.2. (Users shall give their names while registering.), 1.1.3.1.3. (Users shall set up a password while registering to the system) of project requirements list have been implemented in this page. It is connected to the backend and the input is checked.

Login Page

The login page in Android works as expected. The item 1.1.3.2.1.(Users shall be able to login to the system using their email address and their passwords.) of project requirements list has been implemented in this page. The only problem is that when mobile data is used instead of wifi, there are some connection issues. The bug about is opened and the Android team will solve this question shortly.

Language Selection Page

This page is also working perfectly. Only some UI changes need to be done on the language icons. With this page one of the use cases has been realized and item 1.2.3.1. (The system shall support multiple languages.) of requirements has been partly realized; however, for Milestone-1 there is only a test for English Language.

Proficiency Exam Page

Questions are retrieved from the backend and displayed with no problem. The only problem is that this page is not consistent with the frontend version and also requirement 1.1.1.1.2.3. (After every question, the users shall be able to see the correct answer). In Android, the correct answers are not shown and the user only sees the result. Android team will change it and make it consistent with frontend version.

Exam Result Page

Exam results are calculated and updated in the backend. We need to show the result in a more detailed way. Currently, only the A1, A2, etc. level is shown but some level information like intermediate, advanced etc needs to shown as well.

Frontend

Register Page

The register page in the frontend works as expected. Items 1.1.3.1.1. (Users shall give their email address while registering.), 1.1.3.1.2. (Users shall give their names while registering.), 1.1.3.1.3. (Users shall set up a password while registering to the system) of project requirements list have been implemented in this page. It is connected to the backend and the input is checked.

Login Page

The login page in the frontend works as expected. The item 1.1.3.2.1.(Users shall be able to login to the system using their email address and their passwords.) of project requirements list has been implemented in this page. Some UI polish is needed in the frontend generally as the current version seems a little simple.

Language Selection Page

This page is also working perfectly. With this page one of the use cases has been realized and item 1.2.3.1. (The system shall support multiple languages.) of requirements has been partly realized. Currently, we are giving three options to users but only English is working so we need to work on that as well.

Proficiency Exam Page

Questions are retrieved from the backend and displayed with no problem. Unlike the android version, the correct answers are shown after each question by making the correct answer red in the frontend. Thus, the item 1.1.1.1.2.3. (After every question, the users shall be able to see the correct answer) of project requirements list has been fulfilled.

Exam Result Page

Exam results are calculated and updated in the backend. We need to show the result in a more detailed way. Currently, only the A1, A2, etc. level is shown but some level information like intermediate, advanced etc needs to shown as well. The result is shown in a pop-up so.

Backend

Test/Greeting Endpoint

This endpoint was for testing if the API connection works and is no longer needed. But it was very helpful and still actively working.

User Endpoints

Here and endpoint for registering and login. It works as expected and returns the user ID. In case of a wrong input, a response with error code is returned.

Content Endpoints

Content endpoints are currently our most functional endpoints. Here we can get all the languages list, get all exercises, get the proficiency exam questions of one language, create/delete exercises. The endpoint is working and is used actively by frontend and Android.

Grading Endpoints

The users' grades on a language are available in this endpoint. Also, when the user solves the test, the grades posted to this endpoint.

API Documentation

Our API documentatşon can be found in our master branch under Rest API Documentation section and the documentation is updated regularly to contain the latest changes. There are examples of successful and unsuccessfull requests.

🏠 Home

📃 Assignments

👯 Team Members

📚 Resources

Clone this wiki locally