Course full name: Software Design Patterns and Analysis. This is my project report for the course CSE327 at my university. I am sharing this for the juniors to get an idea about writing a good report with different details.
Introduction:
With the advent of computer technology and the internet, consumers prefer to conduct their studies or business online. Student Resource Forum is a question and answer website where one can ask questions, answers, suggests and organizes. Users can collaborate by editing questions and suggesting edits to the answers of others. Users on the Student Resource Forum can comment and write a blog post and like answers.
There are 10 use cases used in this project. These are as follows:
1. Make Question.
2. Do Searching.
3. Give Comment.
4. Upload File.
5. Download File.
6. Add third-party for login.
7. Select Categories.
8. See Profile.
9. See Questions.
10. Complete Registration.
Use Case Diagram
Use case – 1:
Use Case Section
Make Question
Use Case Name
Recent, Most Votes, Most Answers, and Most Views into the website
Level
User-goal
Primary Actor
End user
Stakeholders and Interests
End user wants to successfully see/vote/answer into the website
Preconditions
1. Website must be properly connected to online. 2. User is using website for first time, he/she will have to sign-up.
Main Success Scenario
1. User opens the website. 2. User ask questions. 3. User see recent questions. 4. User answer and vote for questions. 5. User gets most views into the website. 6. User log out successfully from system.
Extensions
2a. User cannot ask question, there must be a database management problem and system is showing an error message. 2a.1: User re-enters question.
Use case – 2 :
Use Case Name
Give Comment
Level
User-goal
Primary Actor
End user
Stakeholders and Interests
User wants to successfully comment into the system.
Preconditions
1. System must be properly connected to online. 2. User must be logged in.
Main Success Scenario
1. User comment on a question. 2. User get up vote or down vote for comment. 3. User get a score from up vote and down vote. 4. System gives user rank based on vote and score. 5. User successfully log out.
Extensions
1a. User cannot comment while database does not process comment and system show error message. 1a.1: User re-enters comment.
Use case – 3:
Use Case Name
Do Searching
Level
User-goal
Primary Actor
End user
Stakeholders and Interests
End user wants to successfully search into the website
Preconditions
1. User must be logged in. 2. System must be properly connected to online.
Main Success Scenario
1. User search for needed content. 2. User search for books, questions and answers and successfully get contents from website. 3. User download or upload needed content. 4. User successfully log out from system.
Extensions
2a. System database not working, the site will stop serving content properly and this happens while the database’s disk fills up and system show error message. 2b. User do not get searched content, because of the content is not uploaded yet.
Use case – 4:
Use case Name
Upload File
Level
User-Goal
Primary Actor
End User
Stakeholders and Interests
End user wants the file to be uploaded successfully.
Preconditions
1. User should be logged in into website. 2. User should be connected with online.
Success Guarantee
On successful completion selected file will be uploaded to the database storage.
Main Success scenario
1. User selects database storage. 2. User enters valid database storage credentials. 3. System and third party system validates the credentials and displays the files in the database storage. 4. User clicks on the upload function on the toolbar. 5. User selects file to be uploaded. 6. System uploads selected file to the database storage and updates list.
Extensions
3a. system displays an error message for Invalid credentials. 5a. System unable to get file name and file size, it displays error message.
Use case – 5:
Use case Name
Download File
Level
User-Goal
Primary Actor
End User
Stakeholders and Interests
End user wants the file to be download successfully.
Preconditions
1. Website should be properly connected to online. 2. User should be logged in.
Success Guarantee
On successful completion selected file will be download.
Main Success scenario
1. User selects database storage. 2. User enters valid database storage credentials. 3. System and third party system validates the credentials and displays the files in the database storage. 4. User clicks on the download function on the website. 5. User selects file to be download. 6. System download selected file.
Extensions
3a. system displays an error message for Invalid credentials. 5a. System unable to get file name and file size, it displays error message.
Use case – 6:
Use case Name
Add third-party for login
Level
User-Goal
Primary Actor
End User
Stakeholders and Interests
End user wants to connect with website easily through Gmail/Facebook
Preconditions
User should have online connection.
Success Guarantee
On successful completion user will log in into website account.
Main Success scenario
1. User selects Gmail/Facebook function. 2. Gmail/Facebook login option comes. 3. User login into Gmail/Facebook account. 4. User than logged in into website account through third party information.
Extensions
3a. User are not connected with Gmail/Facebook and system displays an error message. 3b. System cannot verify user name and password. 3b.1: User re-enters the user name and password.
Use case – 7:
Use Case Name
Select categories
Level
User-goal
Primary Actor
End user
Stakeholders and Interests
End user wants to search different subject and option.
Preconditions
1. User have to be logged in into website account. 2. User have to connect with online.
Success Guarantee
User will successfully explore different categories.
Main Success Scenario
1. User selects categories function. 2. User selects option of his or her choice. 3. User collect needed knowledge. 4. User upload or download different content in different categories. 5. User successfully log out from website.
Extensions
2a. User do not get his needed content, because the content is not uploaded yet in that category. 2b. System is crush because of overload of user and error message will be shown.
Use case – 8:
Use Case Name
See Profile
Level
User-goal
Primary Actor
End user
Stakeholders and Interests
User wants to see other user’s wall, all questions, all answer, comments, gave out, receive and score.
Preconditions
1. User have to be logged in into website account. 2. User have to be connected with online.
Success Guarantee
User will be see what other user’s opinions, questions and answer.
Main Success Scenario
1. User selects user function. 2. User selects another user’s profile. 3. User see other user’s wall, question, answer, comments, up vote, down vote and score. 4. User leave successfully from another user’s profile.
Extensions
2a. User won’t able to visit another user’s account due to database connection problem. 2a.1: User re-click another user profile option.
Use case – 9:
Use Case Name
See Questions
Level
User-goal
Primary Actor
End user
Stakeholders and Interests
User wants to see other user’s answer, up vote, down vote and tag.
Preconditions
1. User have to be logged in into website account. 2. User have to be connected with online.
Success Guarantee
User will be see what other user’s questions and answer.
Main Success Scenario
1. User selects unanswered function. 2. User can see unanswered question, related up vote, down vote, tagged link and tagged person. 3. User can answer of questions, give comments, also can give up vote, down vote and tag.
Extensions
3a. System detects failure to communicate with database system services and show error message.
Use case – 10:
Use Case Name
Complete Registration
Level
User-goal
Primary Actor
End user
Stakeholders and Interests
User wants to sign up at website for open an account.
Preconditions
1. User have to be connected with online. 2. User have to provide Gmail account or Facebook account to open an account.
Success Guarantee
User will be successfully log in into account.
Main Success Scenario
1. User select user name for website. 2. User provide email account or Facebook account. 3. User verify link that is sent from website to Gmail account. 4. User log in into website and see website content. 5. User log out from website.
Extensions
3a. User will get error message if registration information is not right. 3a.1: User re-enters registration information.
Domain Model Diagram:
Class Diagram:
Sequence Diagram:
Technologies Used:
Framework
XAMPP Control panel
PHP (Laravel Framework)
GitHub
Bootstrap (Less)
MySQL (Database)
HTML5
CSS3.
Technical Challenges:
o We had issues while integrating PHPmyadmin database management.
Md Rashad Tanjim
