Skip to content

Requirements

Modjak edited this page Apr 8, 2024 · 55 revisions

Requirements

Table of Contents

Glossary

  1. User: registered user.
  2. Search Engine: searching space where users can enter any keywords or attributes related to artwork, and get search results about artworks.
  3. Labels: subset of wikidata attributes will be chosen by the admin.
  4. Wikidata cards: informative post prepared by system using data extracted from wikidata, shown as a result of the search.
  5. Posts: posts created by registered users either about their museum visits or their own artwork.
  6. Search Result: list of wikidata cards and posts.
  7. Filtering: filter search result according to labels, year intervals

1 Functional Reqs

1.1 User Reqs

1.1.1 Registration/Login:

  • 1.1.1.1 Guest user shall be able to register with an unique username, a hard password and an unique email.
    • 1.1.1.1.1 Password must contain at least one number, symbol, uppercase and lowercase letter. Password must be at least 8 characters and at most 20 characters long.
    • 1.1.1.1.2 Username shall start with a letter and can contain uppercase, lowercase letters, numbers and underscore and dash. Username shall not end with underscore or dash. Username shall be at least 4 characters long and at most 20 characters long.
  • 1.1.1.2 User shall be able to login with their registered username and password.
  • 1.1.1.3 Logged in users shall be able to logout.
  • 1.1.1.4 User shall be able to change their password with another hard password with given details in 1.1.1.1.1.

1.1.2 Guest User

  • 1.1.2.1 Guest user shall be able to see posts, comments on posts and number of likes for a given post.
  • 1.1.2.2 Guest user shall be able to search with given functionalities in 1.2.2.

1.1.3 Registered User

  • 1.1.3.1 User shall be able to create new posts with a title, textual content and photo.
    • 1.1.3.1.1 User shall be able to post their own artwork with its photo. Users shall be able to add labels optionally (in 1.2.3) such as used materials or depictions to the post.
    • 1.1.3.1.2 User shall be able to post a painting they saw in the museum or art gallery to write their feeling on that painting.
    • 1.1.3.1.3 User shall be able to edit their own posts.
    • 1.1.3.1.4 User shall be able to delete their own posts.
  • 1.1.3.3 User shall be able to comment on posts.
  • 1.1.3.4 User shall be able to like the comments and posts.
  • 1.1.3.5 Users shall be able to save user posts to their personal profiles.
  • 1.1.3.6 Users shall be able to view user posts they saved earlier in their own personal pages.

1.1.4 Administrator

  • 1.1.4.1 Administrator shall have access to an admin panel managing users, posts, and other system settings.
  • 1.1.4.1.1 Administrator shall be able to see registered emails of users through the admin panel.
  • 1.1.4.1.2 Administrator shall be able to see number of users, posts, system uptime through admin panel.
  • 1.1.4.1.3 Administrator shall be able to suspend users for any number of days or indefinitely through the admin panel.
  • 1.1.4.1.4 Administrators shall be able to send system-wide notifications to users through the admin panel.

1.1.5 User Interactions

  • 1.1.5.1 Registered users shall be able to follow and unfollow other registered users.
  • 1.1.5.2 Users shall be able to block or report any disturbing user.

1.1.6 Personal Page

  • 1.1.6.1 Users shall have a personal page that shows their posts, comments they have made on other posts.

1.1.7 User’s Collections

  • 1.1.7.1 Users shall be able to create collection of bookmarks for saving the user posts.
  • 1.1.7.2 Users shall be able to create bookmark collections with other users.
    • 1.1.7.2.1 Members of the collection shall be able to bookmark any posts and add it to the collection.
    • 1.1.7.2.2 The bookmarked posts inside the bookmark collection shall be visible to all collection members.

1.1.8 User’s Feed

1.2 System Reqs

1.2.1 Notification

  • 1.2.1.1 System shall send notifications to users when someone comments on or likes their posts.
  • 1.2.1.2 System shall send notifications to users when a user starts to follow them.

1.2.2 Semantic Search

  • 1.2.2.1 System shall allow users to search for paintings.
    • 1.2.2.1.1 System shall allow searching by name of the painting. System shall display the page of the painting as a result of this search.
    • 1.2.2.1.2 System shall allow searching by name of the artist. System shall display the list of the paintings made by that artist as a result of this search.
    • 1.2.2.1.3 System shall allow searching by art movement . System shall display the list of the paintings belonging to that art movement as a result of this search.
  • 1.2.2.2 System shall allow users to filter their search results.
    • 1.2.2.2.1 Filters shall include artist name, art movement, labels, annotation(art work made by user or made by others ) described in 1.2.3.1 and a year interval to filter the paintings that are made between those years.
  • Location

1.2.3 Labels

  • 1.2.3.1 System shall have labels for posts and wiki data cards available in search engines for filtering operations on search.
  • 1.2.3.1.1 Labels shall include materials the painting is made of, genre in the painting.
  • 1.2.3.1.2 System shall include “own artwork” label for users posting their own artwork.

1.2.5 Location

  • 1.2.5.1 Users can search for artworks based on their geographical origins or the locations where they are currently displayed.
  • 1.2.5.2 Artwork uploads can include location tags, allowing users to associate their creations with specific places.
  • 1.2.5.3 The platform will display location information for artworks, helping users explore art from different cultures and regions.

e

2 Non-Functional reqs

2.1 Performance

  • 2.1.1 The system shall respond to any kind of requests within 10 milliseconds.

  • 2.1.2 The system shall support up to 1000 requests per second.

  • 2.1.3 The shall be running at least for a week without any downtime.

2.2 Accessibility/Availability

  • 2.2.1 The system shall be available as a website via any web browser.

  • 2.2.2 The system shall be a mobile application on mobile platforms

2.3 Privacy

  • 2.3.1 The restrictions imposed by KVKK shall be strictly followed.

  • 2.3.2 The copyright of artwork shall be protected if it exists.

  • 2.3.3 Open source acceptance before posting user's own artwork (REVIEW).

  • 2.3.4 The information of any user shall be unavailable to anyone except the Admins.

2.4 UI/UX (usability)

  • 2.4.1 All content shall be seen in English

  • 2.4.2 Text-to-speech feature shall be available for disadvantaged people

Clone this wiki locally