Repository navigation
Requirements and Specification
Requirements and Specification Document
10/12/2022, version 1.4
- Rev. 1.0 2022-10-14 - initial version
- Rev. 1.1 2022-10-26 - project abstract, some user stories, and UI requirements modified
- Rev. 1.2 2022-11-11 - some user stories modified
- Rev. 1.3 2022-11-26 - user stories about places, information updated
- Rev. 1.4 2022-12-10 - overall user stories updated
FITogether is a web service that helps individuals exercise in various ways. For those who have just started exercising, there is a problem with motivation and difficulty finding information for themselves. Therefore, FITogether tries to solve their problem through two main themes: gathering the people through a group challenge system and a more informative community.
In FITogether, users can create or participate in a group challenge. In each group, they can achieve and share their group goals and can be motivated through their communication. Users can also record their exercise logs, and they will see visualized summarization. FITogether has a community in which users can share various kinds of information such as exercise logs, routines, talks, images, and reviews about places. This communication would be strengthened with an AI-tag system, and in-group communities. Moreover, each user can chat or video-call freely with each other. Lastly, FITogether provides exercise-related articles, and videos from the Internet to support our community and have a wide connection to other fitness-related web services.
FITogether's target is anyone interested in fitness and health. As more and more people enjoy exercising day by day, we want to provide various services that can help and motivate them. We expect FITogether to be particularly helpful to the following people.
- Those who have just started exercising and don't know how to start
- Those who want to systematically manage their exercise logs and compare them to others
- Those who want to encourage each other and move forward with common goals
- Those who want information ranging from exercise routines to exercise place reviews or helpful fitness tips
As interest about health and fitness increased so far, there were many fitness-related web services or applications which include 'Planfit', 'SoundGym', 'Fleek', 'BodyCalendar', 'DaGym', 'MonsterZym', 'Challengers', etc. These services provide some information for exercise types and fitness centers, recommend routine based on user's information, or include community systems. However, those features are distributed over the different services, heavily focused on only the mobile devices, and provide somewhat different information depending on the service the user uses. The following figure and table summarize the features of those services. As those services are selected based on their special features or the number of users, the figure can be regarded as a brief summary of related business.
Distributed information about fitness might confuse beginners since there is no exclusive service where they can get the most useful information. Moreover, strong motivation is required to persist their challenge, and especially, this is the case for fitness. For these reasons, FITogether will provide strong motivation through the group system and the challenge system. Also, we will provide well-organized information for each exercise type and build a versatile community through which lots of information can be shared.
Meta Specs
- Feature: Log in for FITogether service
- Actor: A regular user
- Precondition: The user should have already signed up and created his/her own account. The user should not be in the login state.
Scenario
- The user is on the main page, or tries to enter a page that only login users can access. In the latter case, the page is redirected to the login page.
- The user enters username and password, and clicks the login button.
- Upon successful login, the page is redirected to the main page. Unlike before login, the main page displays various elements such as posts and group recruitment.
Exceptions
- Username and password entered are blank
- Account corresponding to username and password does not exist
Acceptance Test
- WHEN the user clicks social login button (Google, Kakao, Facebook)
- THEN if there is no account corresponding to social login information, an account is created and additional basic information is input from the user
- THEN the user state becomes a login state and page is redirected to the main page
- GIVEN that the user enters a valid username and password
- WHEN the user clicks login button
- THEN the user state becomes a login state and page is redirected to the main page
- GIVEN that the user entered a blank or incorrect username and password
- WHEN the user clicks login button
- THEN the user stays on the page without redirecting, and error message for blank or incorrect input is alerted
Meta Specs
- Feature: Create an account for FITogether service
- Actor: User without an account
- Precondition: The user must not be in the login state.
Scenario
- The user clicks 'create new account' at the bottom of the main page or login page.
- The page is redirected to the signup page.
- The user enters information needed to create an account. Inputs required are username, nickname, password, and simple physical information such as height and weight.
- If the sign-up is successful, the user becomes a login state and page is redirected to the main page.
Exceptions
- Duplicate username/nickname, or invalid input exists
Acceptance Test
- GIVEN that the user enters valid inputs
- WHEN the user clicks signup button
- THEN the user's account is created on the server based on the input value
- THEN the user state becomes a login state and page is redirected to the main page
- GIVEN that the user enters one or more invalid input
- WHEN the user clicks signup button
- THEN the user stays on the page without redirecting, and error message is alerted. The message appears appropriate for each situation, such as duplicate values with already existing accounts, incorrect password verification, empty or unselected values, or abnormal body information figures
Meta Specs
- Feature: Become logged-off state
- Actor: A regular user
- Precondition: The user must be in the login state.
Scenario
- Regardless of which page the user is on, the user clicks the logout button.
- A confirmation message appears stating, "Are you sure you want to log out?"
- The user clicks confirm button, and the user becomes logged-off state and the page is redirected to the main page.
Exceptions
- None
Acceptance Test
- GIVEN that the user is working on tasks that require account information, such as modifying profiles
- WHEN the user clicks logout button
- THEN the user state becomes logged-off state
- THEN the page is redirected to the main page without any errors or alerts.
Meta Specs
- Feature: View user's information
- Actor: A regular user
- Precondition: The user must be in the login state.
Scenario
- The user enters his/her profile page.
- The user checks related information such as profile picture, nickname, and list of writing.
- The user clicks 'edit profile' button, changes nickname and profile picture, and then clicks confirm button.
- The information appears with changes.
- The user enters another person's profile page.
- The user clicks 'send message' button on the profile page and sends a message related to the exercise question.
- The user looks up the post about the exercise routine in the list of posts written on the profile page.
- Also, the user can see the scrap-list of posts and fav-list of places in the profile page.
- If the user is the owner of the profile, then the user can modify the scrap-lists and fav-lists.
Exceptions
- Access the profile page of a non-existent user
- Attempt to change profile to invalid input value
Acceptance Test
- GIVEN that the user is logged in
- WHEN the user enters his/her profile page
- THEN the user can check all related information by changing the tab and edit the profile.
- WHEN the user enters another user's profile page
- THEN the user can only see public information, such as nicknames or written posts, and can start chatting with the 'send message' button
- WHEN the user enters the profile page of a user who does not exist
- THEN The user receives a "non-existent user" alert, and the page is redirected to the main page.
Meta Specs
- Feature: Delete FITogether account
- Actor: A regular user
- Precondition: The user must be in the login state.
Scenario
- The user clicks 'sign out' button on his/her profile page.
- A pop-up window appears to check the password, and the user enters the password correctly.
- The page is redirected to the sign-out page.
- After reading the instructions, the user finally clicks the confirm button.
- The FITogether server deletes data about the user.
- The user becomes in a logged-off state and the page is redirected to the main page.
Exceptions
- The password is wrong
Acceptance Test
- GIVEN that the user clicks sign out button and looks at the pop-up window
- WHEN the user enters the wrong password
- THEN a warning message alerts for the wrong input, the pop-up window disappears, and the user sees the profile page
- GIVEN that the user has written a number of posts and comments and belongs to groups and chat rooms
- WHEN the user finally clicks the sign-out button
- THEN posts and comments written by the user are deleted, processed as leaving the group or chat room to which the user belongs, and if the user was the group leader, it is delegated to any user
- THEN the page is redirected to the main page, and the user becomes a logout state
Meta Specs
- Feature: Communicate by sending messages with other users
- Actor: A regular user X, Y
- Precondition: X and Y are both FITogether users.
Scenario
- User X is on user Y's profile page.
- User X clicks 'send message' button, and the page is redirected to the chat page.
- User X sends a question message about exercise to user Y.
- User Y receives a notification about the message.
- User Y checks the message on the chat page and replies to it.
- User X checks the reply message and continues the conversation.
Exceptions
- Send an empty message
- Access chat room with user who has signed out
Acceptance Test
- GIVEN that user X is on user Y's profile page
- WHEN user X clicks 'send message' button and sends a message to user Y
- THEN user Y can see that a message has arrived from a notification icon or a notification page
- THEN user Y can see that a chat room with user X has newly appeared in the chat room list
- THEN user Y can send a message and continue the conversation as user X did
- GIVEN that the user is in one of the chat rooms
- WHEN the user doesn't enter anything in the message input
- THEN the send message button is disabled and appears in a non-clickable
Meta Specs
- Feature: Check for new notifications received
- Actor: A regular user
- Precondition: The user must be in the login state.
Scenario
- The user sees that a new notification has arrived from the notification icon at the top of the web.
- The user clicks the notification icon and then clicks 'more notifications' to go to the notification page.
- The user finds out that there are several new comments posted on user's recent post.
- The user clicks on the notification to go to the post page, reads the comments, and leaves a reply.
Exceptions
- Notifications related to deleted content
Acceptance Test
- GIVEN that the user is on notification page and is viewing various types of notifications
- WHEN the user clicks on one of the notifications
- THEN clicked notification is deleted from the notification list
- THEN the page is redirected to a page of content related to the notification
- GIVEN that the user has not yet checked the notification, and the content indicated by the notification has already been deleted
- WHEN the user clicks on one of the notifications
- THEN An alarm message is alerted that the corresponding content has been deleted, and the page is redirected to the notification page
Meta Specs
- Feature: Record the work out logs about type, weight, reps, and sets
- Actor: Those who want to take notes in a workout
- Precondition: The user must be in the login state.
Scenario
- The user clicks “Record Category”. The user can see the personal goal.
- The user clicks the specific date on the calendar.
- The user chooses the work out type on the drop down, or direct input and enter it manually.
- The user inputs weight, rep, and set columns about the work out type. And can duplicate the row.
- If the user clicks the completed button, it shows the line below and total number of sets.
- If the user clicks the END button, it will be saved.
Exceptions
- Attempt to input non-integer or negative-integer on weight, rep, and set columns.
- A confirmation message appears, “Wrong information format”.
Acceptance Test
- GIVEN that the user is editing the work out logs
- WHEN before clicking the completed button, the user goes to another page
- THEN the changes will be canceled
- WHEN the user clicks the completed button
- THEN the name of the routine is expressed on the calendar
Meta Specs
- Feature: Copy and paste the work out log
- Actor: Those who want to record the same log in another day
- Precondition: The user must be in the login state and have more than one work out log.
Scenario
- The user clicks the duplicate button next to the END button.
- The user clicks the paste button next to the duplicate button.
- If the log already exists on the date, a confirmation message appears. “Do you really want to overwrite the logs?”
- If not or click okay button, the logs will be duplicated on the selected date.
Exceptions
- None
Acceptance Test
- GIVEN that the user is editing the work out logs
- WHEN the user clicks the duplicate button
- THEN confirmation message appears, “You have to save first.”
Meta Specs
- Feature: Itemize the work out logs with the routines
- Actor: Those who want to arrange the logs by the routines
- Precondition: The user must be in the login state.
Scenario
- The user clicks 'Record Category'. Then, clicks the routine button.
- The user clicks (+) button. And enter the name of the new routine.
- The user can add logs entering new information.
- The user also can add with buttons in workout log page.
- The user can see the logs for each routines.
Exceptions
- None
Acceptance Test
- WHEN the user adds the log to the routine by clicking add button
- THEN the user can see the log on that routine
- WHEN the user clicks (+) button and add new routine
- THEN new empty routine appears
Meta Specs
- Feature: Get a list of what groups are currently in place
- Actor: Those who want to get list of groups
- Precondition: The user must be in the login state.
Scenario
- The user gets into GET group list page.
- The user sees list of public groups.
- The user can get list of group places.
Exceptions
- None
Acceptance Test
- GIVEN that the user is logged in
- WHEN the user gets into group list page
- THEN group list is showed
Meta Specs
- Feature: See the detail specifications of the group
- Actor: Those who want to see group specification
- Precondition: The user must be in the login state.
Scenario
- The user can get group specification through click 'get started' from group list page.
- The user can see summary, description, place, specification of the group.
- If the user is already joined this group, the user can see 'Already joined' button below which is deactivated.
- If the user is not joined this group, the user can see 'Join' button below which is activated.
- If the user clicks ‘Join’ button, then the user is joined to that group. And the button is converted to 'Already joined' which is deactivated.
Exceptions
- None
Acceptance Test
- GIVEN that the user is logged in and in group list page
- WHEN the user clicks 'get started' button
- THEN the page is redirected to group specification page
- GIVEN that the user is not in that group
- WHEN the user clicks 'join' button
- THEN the user is joined and button is converted to 'already joined'
Meta Specs
- Feature: Create a new group
- Actor: Those who want to make public or private group
- Precondition: The user must be in the login state.
Scenario
- The user can create group through 'Group List' page > 'Create Group' button.
- The user should write in group challenge name, period, exercise type(at least 1), exercise Intensity(corresponding to exercise type), description.
- The user can make group public or private. Default is public.
- Optionally group places can be registered.
- The user can send invitation to anyone. The user search username and add usernames who will be get invitation.
- Click 'Create' then group is created. The page is redirected to that group’s specification page.
- Click 'Cancel' then the page is redirected to group list page, and everything is not saved.
Exceptions
- Click 'Cancel' button
- Click 'Create' button before write in every required blank
Acceptance Test
- GIVEN that the user is logged in and in group creation page
- WHEN the user clicks 'Create' button
- THEN new group is created and the page is redirected to that group’s specification page
Meta Specs
- Feature: See the main page of a particular group
- Actor: Those who want to see joined group page.
- Precondition: The user must be in the login state and joined in group.
Scenario
- The user can see calendar to the left, and specification to the right.
- At first or if there is no clicked date, then specification is blank.
- If the user clicks date on calendar, then show members challenges on the left.
Exceptions
- None
Acceptance Test
- GIVEN that the user is logged in and joined group
- WHEN the user clicks date of calender
- THEN history of that day is showed up left
Meta Specs
- Feature: Chatting with other users in the group
- Actor: Those who want to chat with others in that group
- Precondition: The user must be in the login state and joined in that group.
Scenario
- The user can see other member’s every previous chatting.
- The user can write message.
- The user can delete user’s own message.
Exceptions
- Bad network
- Delete twice or more
Acceptance Test
- GIVEN that the user is logged in and joined group
- WHEN the user writes comment on chatting page
- THEN the comment is written to chatting page
- WHEN the user clicks delete button of user's own chatting
- THEN pop-up showed up and if user clicks 'ok', chatting is deleted.
Meta Specs
- Feature: Look at the list of members of the group and start video call
- Actor: Those who want to get list of members of group
- Precondition: The user must be in the login state and joined in that group.
Scenario
- The user can get list of group members.
- The user can search group members by username.
- If the user clicks group member’s icon, then user profile pop-up showed up.
- If the user clicks ‘video call’, video call page is opened.
Exceptions
- Bad network when click video call
Acceptance Test
- GIVEN that the user is logged in and joined group
- WHEN the user clicks on one of the members
- THEN member’s user profile pop-up is showed up
- WHEN the user clicks 'video call'
- THEN video call page is opened
Meta Specs
- Feature: Look at the posts of group's posts
- Actor: Those who want to get list of group posts
- Precondition: The user must be in the login state and joined in that group.
Scenario
- The user can get group's post list.
- The user can create group's post.
- The user can comment on group's post.
- The user can delete user's own group post.
Exceptions
- None
Acceptance Test
- GIVEN that the user is logged in and joined group
- WHEN the user get group's posts
- THEN group's posts are listed on page
Meta Specs
- Feature: See the paginated posts of our community
- Actor: Users who want to see posts of our community
- Precondition: The user must be in the login state.
Scenario
- The user gets into this page through the header, can see recent posts.
- If the user clicks 'post', then the page is redirected to the post detail page.
- The user can see the tag list by opening tag detail modal. Also, the user can filter posts by tags.
- If the user clicks 'Search button', then search results will appear based on keyword and the active tags.
Exceptions
- No posts in specified condition
- Search with empty keyword
Acceptance Test
- GIVEN that the user is logged in
- WHEN the user clicks 'Community' tab
- THEN recent posts with default tags listed on the page
- WHEN the user clicks 'tag detail' button(tag modal opening button)
- THEN the tag detail modal should be opened
- WHEN the user clicks 'Search' button
- THEN recent posts with active tags and the keyword listed on the page
- WHEN the user clicks each post
- THEN the user enters the detail page of the post
Meta Specs
- Feature: Create a post, Upload images, Link elements to the post, Create a tag
- Actor: Users who want to create a post
- Precondition: The user must be in the login state.
Scenario
- The user is on the posts list page.
- If the user clicks 'create' button, then the page is redirected to the post creation page.
- The user fills information needed to create a post. Title and Content(plain text) are required. Image(up to 5), routine(up to 1), group(up to 1), and tags(unlimited) are optional.
- The user can link existing tags or create new tag(only general tags).
- The user can search tags by keywords.
- The user can set a prime-tag.
- If the user clicks 'create confirmation' button, the post would be registered in the server and the page would be redirected to the post detail page.
Exceptions
- Empty or too long title and contents
- Inappropriate(ex. Too big) image
Acceptance Test
- GIVEN that the user is logged in and enters the creation page
- WHEN the user selects a tag for the post
- THEN the selected tag should be linked to the post content
- WHEN the user selects a routine(or group) for the post
- THEN the selected routine(or group) should be linked to the post content
- WHEN the user uploads an image for the post
- THEN the uploaded image should be linked to the post content
- WHEN the user fills valid title and contents for the post, and clicks 'create confirmation' button
- THEN the post is created on the server and the page is redirected to the post detail page
Meta Specs
- Feature: Create a comment, Like(Dislike) the post(comment), Scrap the post
- Actor: Users who want to read the post
- Precondition: The user must be in the login state.
Scenario
- The user navigated to the post detail page by clicking the post in posts list page.
- The user can create a comment(or comment reply) through 'create comment' button.
- The user can toggle the notification about the post through 'toggle notification' button.
- The user can like, dislike, or scrap the post.
- The user can like, or dislike the comment.
Exceptions
- Empty comment
Acceptance Test
- GIVEN that the user is logged in
- WHEN the user can click 'like', 'dislike', and 'scrap' button for each corresponding tasks.
- THEN the corresponding indicator will be changed appropriately
- WHEN the user clicks 'create comment' button after entering the comment content
- THEN the comment should be registered in our server and should appear immediately
Meta Specs
- Feature: Delete the post
- Actor: Users who want to delete the post
- Precondition: The user must be in the login state and the user created the post.
Scenario
- The user is on the post detail page.
- If the user clicks the 'delete' button, an alert for the deletion would appear.
- If the user clicks the confirmation button, the server would delete data about the post(including comments).
- The page is redirected to the posts list page and the notification is triggered.
Exceptions
- Already deleted post
Acceptance Test
- GIVEN that the user is logged in and clicks 'delete' button and looks at the pop-up window
- WHEN the user clicks confirmation button
- THEN the post and comments about the post are deleted
- THEN the page is redirected to the posts list page and the notification is triggered.
Meta Specs
- Feature: Edit the comment, Delete the comment
- Actor: Users who want to edit or delete the post
- Precondition: The user must be in the login state and the user wrote the comment.
Scenario
- The user is on the post detail page.
- If the user clicks 'edit' button for the comment that the user wrote, then the form for the edit would appear.
- The user can finish the edition through 'edit confirmation' button and a notification is triggered.
- The user can cancel the edition through 'edit cancel' button.
- If the user clicks 'delete' button for the comment, then the alert for the deletion would appear.
- The user can confirm the deletion through 'delete confirmation' button, then the comment would be deleted from the server and a notification is triggered.
Exceptions
- Empty comment
- Already deleted comment
Acceptance Test
- GIVEN that the user is logged in and wrote the comment
- GIVEN the user is in the post detail page
- WHEN the user clicks 'edit' button of the comment
- THEN the edit form should appear and the user can finish or cancel the edition
- WHEN the user confirms the edition
- THEN the comment is edited in the server and a notification is triggered
- WHEN the user clicks 'delete' button of the comment
- THEN the delete alert should appear and the user can confirm or cancel the deletion
- WHEN the user confirms the deletion
- THEN the comment is deleted from the server and a notification is triggered
Meta Specs
- Feature: Edit a post
- Actor: Users who want to edit a post
- Precondition: The user must be in the login state and the user created the post.
Scenario
- The user is on the post detail page.
- The user clicks the 'edit' button.
- The page is redirected to the post edit page.
- The user edits and clicks 'edit confirmation' button.
- The FITogether server updates data about the post, the page is redirected to the post detail page and the notification is triggered.
Exceptions
- Empty or too long title and contents
- Inappropriate(ex. Too big) image
Acceptance Test
- GIVEN that the user is logged in and clicks 'edit' button and the page is redirected to the post edit page
- GIVEN the user edit the data related to the post
- WHEN the user clicks confirmation button
- THEN the post are edited in the server
- THEN the page is redirected to the post detail page and the notification is triggered.
Meta Specs
- Feature: List all workout tags
- Actor: Users who want to get information about the workout
- Precondition: The user must be in the login state.
Scenario
- The user is redirected to the workout lobby page by clicking 'information' tab in the header.
- The user can search workout type or just click tag in list to go information detail page.
Exceptions
- None
Acceptance Test
- GIVEN that the user is logged in
- WHEN the user clicks 'information' tab
- THEN the workout tag list should be showed
- WHEN the user searches certain workout type
- THEN the page is redirected to the workout type
- WHEN the user clicks the tag included in the workout tag list
- THEN the page is redirected to the linked page
Meta Specs
- Feature: Crawl and Organize information about the specified workout
- Actor: Users who want to get information about the workout
- Precondition: The user must be in the login state.
Scenario
- The user can see workout information(Youtube links, tagged post, etc).
- If the user clicks the youtube item, then new tab is opened with the youtube video link.
- If the user clicks the post item, then the page is redirected to the post detail page.
- If the user clicks the group item, then the page is redirected to the group detail page.
Exceptions
- Information does not Exist
- Crawling exception
Acceptance Test
- GIVEN that the user is logged in
- WHEN the user redirected to the information detail page
- THEN the proper information should be summarized
- WHEN the user clicks a youtube item
- THEN the page is redirected to the youtube page(external)
- WHEN the user clicks a post item
- THEN the page is redirected to the post detail page
- WHEN the user clicks a group item
- THEN the page is redirected to the group detail page
- Description: User-related pages of FITogether and the main page of FITogether.
- Description: Community-related pages of FITogether. In the community tabs, there are three sub-tabs: posts, places, and information sub-tab. Chats and video calls are also included in this Community section.
- Description: Workout log registration pages of FITogether. Users can easily upload their workout logs with our routine system.
- Description: Group-related pages of FITogether. Each group has their own goals to achieve. They can also communicate with other group members in private manner.