CS100 Final Project

Fall 2021

 

Description

You will be forming a group of FOUR students and working on an interesting project. The project has 4 phases, each one with specific requirements. A list of proposed project ideas that have been successful in previous quarters is listed at the end of this document. You can select an idea from the list, start thinking about the features you will implement, what design patterns can help you implement them, and why. If you want to propose your own original idea, you will have to contact an instructor to discuss the project and obtain written permission before you submit your project proposal (Phase 1). Your project needs to implement at least two design patterns iteratively, which you will have to justify for later phases.The project work should be divided almost equally among team members and each member is expected to work on at least one design pattern (more than one partner may work on a pattern) and some of its test cases. You can of course help each other, but it needs to be clear who will be responsible for which patterns and for which features. Additionally, you are expected to follow Scrum patterns, specifically the use of a Scrum (Project) board, Sprints, and Scrum meetings. While Daily Scrums are not required we highly recommend you practice them too.

 

Expectations

● Incorporate at least TWO distinct design patterns

○ You need to include at least one design pattern that we will teach this session (Composite, Strategy, Abstract Factory or Visitor)

● All design patterns need to be linked together (it can’t be two distinct projects)

● Your project should be implemented in C++. If you wish to choose another programming language (e.g. Java, Python), please discuss with your lab TA to obtain permission.

● You can incorporate additional technologies/tools, but they must be approved (in writing) by an instructor or the TA.

● Each member of the group must be committing code regularly and should make sure their code is correctly attributed to them. We will be checking the attributions to determine if there was equal contribution to the project.

● Each member of the group must actively participate in the Github Kanban board and reviewing commited code

● All project phases are to be submitted to GitHub. You should modify the README file in

your project GitHub repository to reflect the different phases of the project. In addition, you should regularly hold sprint meetings with your group. You will need to hold one check-in meeting with your lab TA in addition to the final demo. Details of these meetings are presented below.

 

 

 

 

Phase I - Proposal (Due Wednesday 10/20/2021 10:00 pm)

You will be completing Phase I prompts in the README.md file in your project GitHub repository. The README.md file will need to have:

● Title of the project

● Group member names, and links to their GitHub pages

● A Project description

○ Why is it important or interesting to you?

○ What languages/tools/technologies do you plan to use?

○ What will be the input/output of your project? What are the features that the project provides?

 

The description should be in enough detail that the TA/instructor can determine the complexity of the project and if it is sufficient for the team members to complete in the time allotted.

 

You also need to set up an empty project board by choosing the “Automated kanban with review” option on Github. You should also have a Backlog and In testing columns added.

 

 

Points: 35

 

Phase II - Design documents (Due Friday 11/5/2021 10:00 pm)

Update the README.md file by adding the following:

● A class diagram of your project (using UML)

● A description of the class diagram Additionally, you will need to:

● Create an “Epic” (note) for each feature and each design pattern (in the Backlog column) and assign to the appropriate team member

● Complete your first sprint planning meeting to plan out the next 7 days of work.

 

 

 

 

 

Points: 90

○ Break down the “Epics” into smaller and actionable user stories (i.e. smaller development tasks), (in the TODO column). Create issues for them, and assign them to the appropriate team member.

○ These cards should represent roughly 7 days worth of development time for your team, taking you until your sprint meeting with the TA.

 

 

Phase III – Development, Testing and Scrum Meeting (Due week 8 at lab time)

You will need to schedule a check-in with the TA (during lab using Calendly). Your entire team must be present.

 

Before the meeting you should perform a sprint plan like you did in Phase II. You should also update the README.md file by adding the following:

● What design patterns did you use? For each design pattern you must explain in 4-5

sentences:

○ Why did you pick this pattern? And what feature did you implement with it?

○ How did the design pattern help you write better code?

● An updated class diagram

 

During the meeting with your TA you will discuss:

● How effective your last sprint was (each member should talk about what they did)

● Any tasks that did not get completed last sprint, and how you took them into consideration for this sprint

● Any bugs you have identified and created issues for during the sprint. Do you plan on fixing them in the next sprint or are they lower priority?

● What tasks you are planning for this next sprint.

 

You may notice that this is effectively a “scrum” meeting although we suggest that as a team you have daily (or every other day) scrum meetings.

 

Make sure your README.md file and Project board are up-to-date reflecting the current status of your project (e.g. any changes that you have made during the project such as changes to your class diagram). Previous versions should still be visible through your commit history.

 

Points: 75

Phase IV - Final Deliverable (Due week 10 at lab time)

All group members will give a demo to the TA during lab time. The TA will check the demo and the project GitHub repository and ask a few questions to all the team members.

 

Before the demo, you should update the README.md file by adding the following:

● Screenshot of input/output after running your application

● Installation/usage instructions for the application (including dependencies)

● How the project was tested/validated

 

Note that your README.md file and Project board should reflect any recent changes you made in your project. Previous versions should still be visible through your commit history.

 

In addition to this, you need to plan one more sprint (that you will not necessarily complete before the end of the quarter). Your In-progress and In-testing columns should be empty (you are not doing more work currently) but your TODO column should have a full sprint plan in it as you have done before. This should include any known bugs (there should be some) or new features you would like to add. These should appear as issues and cards on your Project board.

 

Points: 100

 

 

 

List of Project Ideas

●  Task Scheduler: In this application, a user can create tasks including a title, description, classification (e.g. personal, work, study), priority, duration and due date. Some of these features can also be optional. Users can also create task lists where each list includes multiple tasks. Task lists can represent larger tasks that have subtasks within them. Users can display, edit, and delete tasks and task lists. Users should also be able to undo these operations.

 

●  Quiz Maker: This application allows instructors to create quizzes by uploading text files representing question pools. The uploaded file can contain a list of different types of questions (e.g. multiple choice, true/false, free response) as well as the correct answers (answers can be optional for free response questions). The instructor can then automatically create a quiz based on the uploaded question pool by specifying the required questions types and number of questions. A quiz can also have questions consisting of other sub-questions of different types. Instructors can allow students to take a quiz once or multiple times. The quiz maker can also support multiple file formats for uploading question pools (e.g. plain text, JSON).