Practice App Requirements

Glossary

• Article: Wiki contents in which registered users give information about medical-related subjects. Articles may be about illnesses, drugs, therapeutic approaches etc.

• Article-owner: Registered user who creates the article in the Articles.

• Category: One of the major disciplines in medicine, e.g.: Neurology, Pulmonology, Cardiology, etc.

• Comment: Responses given by registered users to a post.

• Downvote: A feature in the forum where registered users can use when they think a post or a comment does not contribute to the discussion, or they don't like or don't endorse it.

• Guest User: A user who hasn't registered to the application and does not have an account.

• Post: Starting content of a discussion thread in which a registered user can ask question about his/her disease, make suggestion or review of his/her medical experiences. It has a title and a body.

• Post-owner: Registered user who creates the post in the forum.

• Rate: To upvote or downvote a post or a comment.

• Registered User: A user who has registered to the application and has an account.

• Upvote: A feature in the forum where registered users can use when they think a post or a comment contributes to the discussion, or they like or endorse it.

• User: Someone who uses the application. Users are divided into two sub-categories: Registered User and Guest User.

• Username: Name that members use in the website and app.

• Valid username: A username which includes alphanumerical characters and which is distinct from other usernames.

• Valid email: A email passes the validation tests and which is distinct from other usernames.

• Valid country name: A country name that exists in the response of the used external COVID19 API.

1. Functional Requirements

1.1 User Requirements

• 1.1.1 Registering

  • 1.1.1.1 Sign-up

    • 1.1.1.1.1 Registered users shall have a secure password
    • 1.1.1.1.2 Registered users shall register their unique e-mail to the system while registering.
    • 1.1.1.1.3 Registered users shall register their unique username to the system while registering.
    • 1.1.1.1.4 Registered users shall create a new user with valid username, valid email and password.
    • 1.1.1.1.5 Registered users shall view all users registered to system.
    • 1.1.1.1.6 Registered users shall view a specific user registered to system.

  • 1.1.1.2 Sign-in & Sign-out

    • 1.1.1.2.1 Registered users shall be able to sign-in.
    • 1.1.1.2.2 Registered users shall be able to sign-out.

• 1.1.2 Platform Components

  • 1.1.2.1 Post

    • 1.1.2.1.1 Registered users shall be able to create a post.
    • 1.1.2.1.2 Registered users shall add a title, body, category and country while creating a post.
    • 1.1.2.1.3 Registered users shall be able to see all posts.
    • 1.1.2.1.4 Registered users shall be able to view a specific post providing its id.
    • 1.1.2.1.5 Registered users shall update a title, body, category and country while creating a post.
    • 1.1.2.1.6 Registered users shall be able to upvote or downvote a post.

  • 1.1.2.2 Comment

    • 1.1.2.2.1 Registered users shall be able to create a comment for a post by providing post id, category, and city name.
    • 1.1.2.2.2 Registered users should be able to update a comment by providing post id, category, and city name.
    • 1.1.2.2.3 Registered users shall be able to see all comments of a post by providing a post id.
    • 1.1.2.2.4 Registered users shall be able to see a specific comment by providing a comment id.
    • 1.1.2.2.5 Registered users shall be able to upvote or downvote a comment.

  • 1.1.2.3 Article

    • 1.1.2.3.1 Registered users shall be able to create articles.
    • 1.1.2.3.2 Registered users shall add a title, body and category to their articles.
    • 1.1.2.3.3 Registered users shall be able to see all articles.
    • 1.1.2.3.4 Registered users shall be able to update articles they created.
    • 1.1.2.3.5 Registered users shall be able to upvote or downvote an article.

  • 1.1.2.4 Category

    • 1.1.2.4.1 Users shall be able to create categories.
    • 1.1.2.4.2 Users shall be able to view all categories.
    • 1.1.2.4.3 Users shall be able update a category.
    • 1.1.2.4.4 Users shall be able to view all posts belongs to a category.

1.2 System Requirements

• 1.2.1 Post

  • 1.2.1.1 System should add covid-19 data to a post if a valid country name is provided.

• 1.2.2 Comment

  • 1.2.2.1 System should add weather data to a comment if a valid city name is provided.

• 1.2.3 Category

  • 1.2.3.1 System should add dictionary definition data to a category if a valid name is provided.

• 1.2.4 User

  • 1.2.4.1 System should check the domain of the email of new user if a valid email is provided.

2. Non-Functional Requirements

2.1 Availability & Accessibility

• 2.1.1 The system shall have a web application/interface, available through web browsers such as Chrome.
• 2.1.2 The system language shall be English.
• 2.1.3 The system shall support UTF-8 character encoding.

2.2 Security

• 2.2.1 Registered users' password shall be a minimum of 6 characters long
• 2.2.2 System shall store hashed passwords.