Practice App: Requirements

Glossary

• End-user (admin): A person or other entity that consumes or makes use of this application. End User is considered as an admin and functionalities are provided accordingly.
• User: The user of the application or website who has previously registered.
• Art Item: A visual piece of art belonging to a specific user.
• Description: An entry, or statement that gives details about the art item, written by the owner of the work.
• Comment: A written remark expressing an opinion or reaction under an art item.
• Username: A string that allows registered users to log in to their accounts. It will be publicly visible to other users and shall be unique.
• ID: A unique identification number assigned to the entities in the system. A user, comment, and art item can have unique IDs.
• Follower: A user following another user.
• Tag: A string that can be used to identify an art item.

Requirements

1. Functional Requirements

1.1. User Requirements

1.1.1. Art Items

• 1.1.1.1. End-user shall be able to view all the art items in the system.
• 1.1.1.2. End-user shall be able to view an art item by providing the ID of the art item.
• 1.1.1.3. End-user shall be able to view art items of a specific user by providing the ID of the user.
• 1.1.1.4. End-user shall be able to view art items of a specific user by providing the username of the user.
• 1.1.1.5. End-user shall be able to create an art item by providing a title, description, image, tag IDs, and ID of the user (owner of the work).

1.1.2. Tags

• 1.1.2.1. End-user shall be able to list all of the tags in the system.
• 1.1.2.2. End-user shall be able to add new tags to the system.
• 1.1.2.3. End-user shall be able to delete a tag from the system.
• 1.1.2.4. End-user shall be able to get a list of all of the ArtItems that have the tag in their tags field, via providing the name of the tag.

1.1.3. Comments

• 1.1.2.1. End-user shall be able to list all of the comments of a specific art item in the system by providing id of the art item.
• 1.1.2.2. End-user shall be able to post comment on an art item in the system by providing comment body, ID of user who comments, and ID of art item.
• 1.1.2.3. End-user shall be able to delete a comment of an art item from the system by providing comment ID and user ID who posted the comment.

1.1.4 Miscellaneous

• 1.1.4.1. End-user shall be able to list information and episodes of the given TV series.
• 1.1.4.2. End-user shall be able to get a list of all of the unanswered questions in stackexchange.
• 1.1.4.3. End-user shall be able to get a list of all of the unanswered questions in stackexchange that are tagged with the given tag, via providing the name of the tag.

1.2. System Requirements

1.2.1. Art Items

• 1.2.1.1. End-user shall be able to upload only one image for an art item. If not provided, the image of the art item is set as a default image in the system.

1.2.2. Comments

• 1.2.2.1. End-user shall be able to provide comment body, ID of user who comments, and ID of art item to post comment. Comment ID, date created, and date updated are provided by the system.

2. Non-Functional Requirements

2.1. Portability

• 2.1.1. The system is mainly a web application with necessary API implementations.