Course project: Beta release

Overview

Solidify your toolchain and processes, implement the core components, and demo an early release of your product.

Due Tues 11/7/23 11:59pm PT. Submit in Canvas and GitHub as directed (check Calendar for any updates). Note the revision policy changes starting with this software release. See the Project tab for more details.

Set up

Work with your project team to (1) solidify your toolchain and processes, (2) provide initial documentation, and (3) present an early demo of your product to the class.

Instructions

1. Solidify your toolchain, processes, and instructions (40%)

• All technical processes (version control, bug tracking, build system, testing and CI) must be fully functioning and documented. We expect proper use of version control, including coherent commits with descriptive commit messages.

• Your GitHub repository must provide a top-level README with:

  • Clearly labeled instructions for how to build and test the system. (Strive for a high degree of automation.)
  • Clearly labeled instructions for how to run the system.
  • Include the version id of the Beta release.



• Complete this in the main branch of your repository by the deadline.

2. Implement and integrate first version of your system's major components (40%)

• Implement a first release of working software for your system. At least one use case that touches all major components of your system must be operational. For example, in the case of a client-server web application, a user command invoked from the front end should be able to return data from the back end.

• The top-level README in your repository must reflect which use case(s) are operational. You do not need to have all features implemented but at least one core feature/core use case should be minimally operational to show that the basic components of your system are implemented, integrated, and working.

• Complete this in the main branch of your repository by the deadline.

3. Prepare and present a live short demo and reflection (20%)

• Your 7 minute (max) in-class presentation should have two parts:

  1. Slide introduction and reflection (max 3 min):

  • Project name and dev team. [one slide]
  • Introduction of the problem and your solution (background information to set the stage). [one slide]
  • A reflection on the current experience, addressing (1) process and timeline, (2) architecture and design, and (3) testing and tooling. Include insights and changes based on work to date. [three slides]
  
  

  2. A demo of your beta release (max 4 min):

  • Focus on the operational use case(s), highlight major accomplishments, and discuss open challenges.



• Save the slidedeck as ProjectName_BetaDemo.pdf.

• Email the staff (cse403-staff@cs.washington.edu) with the name of who will be hosting the presentation, so we can send the zoom meeting link for class. When it is your turn to present, you will screen-share from your laptop.

• Further requirements:

  • Each group member must participate in some way in the in-class presentation (e.g., presenting, running the demo, answering questions).
  • You must stick to the timeline of at most 7 minutes total. We will allow an additional 1 minute for questions (e.g., 8 minutes including questions).
  • If appropriate to make your demo more realistic, you may pre-populate any database or other data source with an amount and type of (possibly faked) data that a typical user would see.

4. Submit

• Submit the slide component of your presentation to Canvas by the deadline.
• Present demo and reflection to class per schedule on Wed 11/8 (class time) and Thurs 11/9 (section).

Clarifications

What are improper uses of version control?

Not adequately utilizing version control. For example, few, enormous commits that contain almost all of the source code reflect an improper use of version control and will lead to point deductions. As another example, commits with no comments to explain the purpose of the update will lead to point deductions.