Requirements - swe574-team2/swe574_team2 GitHub Wiki

Functional Requirements

Registration and Login

As a user, I want to register by choosing my own credentials, so that I can use the application.
As a user, I want to login to the application, so that I can access my personal space.
As a user, I want to logout from the application, so that I can be sure someone else using the same computer cannot access my private space.
As a user, I want to be able to set my password if I forget it, so that I can keep accessing my personal space.

User

As a user, I want to access my profile, so that I can change my username, email address and profile picture.
As a user, I want to follow the desired users on the platform, so that I can see their posts on my personal space.
As a user, I want to unfollow the desired users on the platform, so that I will not see their posts on my personal space.
As a user, I want to filter out the posts of a specific user, so that I can see the posts of desired user in a grouped way.

Posts

A post shall mandatorily have a title, link and description.
A post shall optionally have an image.
If the post doesn’t have an image, there shall be no default image in the post.
A post shall belong to one or more spaces (it shall belong to at least one space).
In the post’s preview; the title, link and description of the post doesn’t have to be shown in full if they’re too long.
Title, link and description of the post shall be shown in full in the post’s own page.
If available, the post should show a preview of the page when the cursor is hovered over the post’s link.
A post shall have descriptive or informative tags (Wikidata entities).
When clicked on the post’s link, the post shall redirect to the linked webpage.
A post shall be liked or commented by other users based on the space policy and post owner’s preferences.
A post shall be posted publicly to a space, or be kept private in the post owner’s personal space.
A post shall be added to (or removed from) favorite posts.
A post and its different parts (image, parts of image, link, title, description etc.) shall be annotated.
A post shall not be edited once posted.
A post shall be deleted by its owner.
A post shall be deleted by space owner or moderators based on the space policy.
If a post contains the same link as another post shared in the "same space", the user should be informed about the link duplication and give confirmation if they want to share another post with the same link.

Space and Homepage

As a user, I want to see the posts of the users that I follow, so that I will not be distracted by the posts that I am not interested in.
As a user, I want to see the posts recently shared by all users, so that I will be able to catch up with the popular topics.
As a user, I want to filter out the posts of a specific user, so that I will be able to see the desired user's posts in a grouped way.
As a user, I want to reach my saved posts, so that I don't forget something important for me.
As a user, I want to filter out the posts with respect to a desired tag, so that I will be able to see the posts about similar topics together.
As a user, I want to search for the posts including a desired keyword, so that I will be able to filter out the posts having a specific keyword.
As a user, I want to see other's comments on the shared posts, so that I can read what others think about the topic.
As a user, I want to like / unlike a post, so that I can encourage other users about sharing valuable content and enable users of the platform to be aware of valuable sharings.

Space Contributor Policies

Any member of the space:

Any member of the space can create new posts and add them to the space.
They can edit or delete their own posts.
They can view and interact with other posts within the space, such as commenting or adding annotations.
They cannot edit or delete posts created by other members.

Only users who have been granted posting rights:

The owner of the space can grant posting rights to specific users.
Users with posting rights can create new posts and add them to the space.
They can edit or delete their own posts.
They can view and interact with other posts within the space, such as commenting or adding annotations.
They cannot edit or delete posts created by other users without posting rights.
The owner of the space can revoke posting rights at any time.

Only moderators:

The owner of the space can assign moderator roles to specific users.
Moderators can create new posts and add them to the space.
They can edit or delete any posts within the space.
They can view and interact with other posts within the space, such as commenting or adding annotations.
They can warn and remove abusive content from posts.
They can warn users who are disruptive, such as posting way too many things, or duplicates, etc.
They can block users who continue to post inappropriate content despite warnings.
They can permanently remove users who have been blocked.

Recommendations

The user should be able to see recommendation in a separate page.
The user should be able to see recommendation with the same qualities as posts. --
The user should be able to like and comment on recommendations.--
The system should be able to recommend posts which are liked by connections of the user.
The system should list posts according to their liked counts.
The system should be able to generate recommendations quickly and accurately. --
The system should be able to handle peak usage times and be available to ensure a smooth user experience --

Badges

Badges must be earned at the space level.
Users can earn badges in the categories of "the owner of the most liked post", "the person who shared the most posts (top contributor)", "regular contributor ".
A moderator can give an “original” badge to a desired post/user in the space.
Each badge must have an icon.
A user should be able to have more than one badge.
A user should be able to earn badges in different spaces.
Badges earned by the user should be displayed on the profile page next to each space name they have joined.
When clicking on each of the badges that a user has won, all posts that earn this badge should be displayed in the relevant space.
“The most liked post” in a space should be displayed with an icon right next to the post title.

Search Functionality

The search function should allow users to search for posts and spaces based on keywords contained within their titles, descriptions, and tags.
The search function should allow users to filter their results by date, relevance, popularity, and other relevant criteria.
The search function should be able to return results for posts and spaces even if the user misspells the keywords or uses synonyms.
The search function should also be able to suggest related posts and spaces to the user based on their search query.
The search function should allow users to search for posts and spaces based on their annotations, either by filtering for specific types of annotations or searching for keywords within the annotations themselves.
The search function should be able to prioritize the results that have been annotated by users with a higher reputation or badge level.
The search function should also allow users to search for posts and spaces based on the user who created them, or the user who contributed to them in some way (such as by annotating or commenting on them).

Warning and Removing People About Abusive Content

Owners can define the policies of the space:

The owner of the space can set policies for how contributions can be made to the space.

They can choose who is allowed to create new posts and who has editing and deletion rights for posts.
They can set rules for what type of content is allowed in the space, and what type of content is not allowed.
They can assign roles to members, such as moderators or users with posting rights.
They can change the policies and roles at any time.

Moderators can manage and remove abusive content:

Moderators can view all posts within the space.
They can identify posts that violate the policies of the space or contain abusive content.
They can remove or edit posts that violate the policies of the space or contain abusive content.
They can send warnings to users who violate the policies of the space, such as posting duplicates or irrelevant content.
Moderators can track the number of warnings given to users and take further action if necessary.

Moderators can warn people who are disruptive:

Moderators can send warnings to users who are disruptive, such as posting way too many things or duplicates.
They can explain to the user what they did wrong and why it is not acceptable.
They can suggest ways for the user to improve their contributions to the space.
If the user continues to be disruptive, moderators can take further action, such as blocking or permanently removing the user from the space.

Non-functional Requirements

Passwords shall be kept encrypted in the database, so that anyone cannot reach users' passwords even if a data leak occurs.
The application shall be dockerized, so that it can be deployed and run on any platform easily.
The application shall be deployed to cloud and assigned a public IP, so that it can be reachable over the internet.
Error logs shall be tracked in the system, so that the developer can investigate any problem that occurs in the system.
Register, login, post counts shall be reachable, so that the succeess of the the app can be tracked.
Annotations on posts shall be made in W3C Web Annotation Data Model.
Informative tags on posts should use Wikidata entities as tag names.

Requirements - swe574-team2/swe574_team2 GitHub Wiki

Functional Requirements

Registration and Login

User

Posts

Tags

Space and Homepage

Space Contributor Policies

Recommendations

Badges

Search Functionality

Warning and Removing People About Abusive Content

Non-functional Requirements