Lab 10: Final Project
CS 141: Introduction to Programming , Spring 2018

Sample Code

If you need to create multiple frames or panels, download and unzip Code.zip which contains 2 Netbeans projects, one which uses 2 frames and the other uses 1 frame with multiple panels. Figuring out the code by just looking at it may be confusing. In class, the instructor can demonstrate how the projects were put together.

Instructions

For this lab, you may implement an application of your choice. If you aren't sure what to do, then it is suggested that you do the database project described below.

Regardless of what you do, the primary requirements are that:

1. You collaborate with one other person.
2. Your program uses a Graphical User Interface (GUI)
3. Your program reads and/or writes to files.
4. Your program makes use of arrays or ArrayLists or some non-trivial data structure.

Examples include:

• A database: General directions are described in DBAssign.pdf. While this pertains to creating a database, it provides an example of the scope and complexity any project you do.
• A game (e.g. card game, board game, etc). Turn-based games will be most manageable. It is suggested that you avoid games involving animation as they generally require something called Threads, which we have not covered in class.

Coordination with your Partner

• Attendance: You are both expected to attend all labs and lectures so that you can collaborate.

• Maintain Good Communication: After you pick a partner, be sure to exchange methods of communication (email, phone, etc). You may not need to get together outside of class or lab, but you need a way of communicating in case there are problems or questions. The most common reason for frustration and failure to get the assignment done is due to poor communication. If you must miss a class or lab, be sure to 1) inform your partner ahead of time and 2) provide your partner with any files or information they need in order to work on the project by themselves.

• Backup and Version Control of Software: Normally, when doing a large project, programmers use version control software as a way to share and maintain versions of the software. We will not require such software in this lab because learning to use such software can take time. You will learn more about these options if you take higher level cs classes. That said, keeping code organized and up-to-date is important. Be sure to discuss with your partner how you plan on doing this.

  It is required that you keep multiple versions of backup copies of your program as you work. For example, every few days (or if you have made large changes), copy your entire netbeans project folder and any other needed files to a safe location, e.g. to an entirely different folder on your H:drive, or a thumb drive, or external drive, etc. If something goes wrong, you do not want to have to re-implement your entire program. Instead, you just need to redo the code from the last back-up. Losing files is not a legitimate excuse for not completing your project on time.

Deadlines

• Friday, Apr 13: Submit to WISE (go to Lab 10: Final Project Proposal) a typed 1/2 - 1 page description of your program. Include project title and names of both partners. Part of lab time on this day will be devoted to you and your partner working on this. Implementation details are not expected, however, you should include as many specifics about the project as possible. For example, if it is a game, include the rules of the game, what the board looks like (if there is one), how many players, are you playing against the computer or not, etc. If you are doing a database, you should include a list of the kind of data you intend to include along with sample queries.
• Monday Apr 16 or Friday, Apr 20: You should have completed a first pass of your UML diagram preferably by Monday Apr 16. Meet with the instructor to go over the details of the diagram. The sooner you discuss this with the instructor, the better because it will help to clarify the structure of your program. Note, try to identify which partner will implement what. While you are free to work together on some of the code, it is expected that each partner will be independently responsible for some portion of the program.
• Friday, Apr 27: Lecture and lab time will be devoted to demoing your 99% completed program. A sign-up sheet will be available. Some slots may extend past the end of lab. There will be no time for debugging. You will show whatever you have. Except for minor issues, the program should run and be complete.
• Monday, Apr 30:
  • Final presentations during lecture and lab.
  • No later than 6pm: Submit final deliverables (see below) to WISE (go to Lab 10: Final Project).

Grading

Grading will be based on

• the ability to meet deadlines.
• the ability to communicate and collaborate with your partner.
• meeting the primary requirements.
• the quality of the work (code structure/comments/formatting, UML, presentation).
• the completeness of the work (was everything turned in).

Final Deliverables

1. Proposal: By April 13, you should submit your proposal to WISE. Look for the assignment titled on WISE:

   Lab 10: Final Project Proposal

   Note: All other items below should be submitted to the assignment titled on WISE: Lab 10: Final Project

2. Presentation: Plan to give a 5-10 minute presentation of your project on the day of the final exam slot. It should include:

   • Introduction - your names and a brief description of what your program does.
   • Run the program to demonstrate how it works.
   • Show the UML diagram - briefly explain what each class does and who did what.

3. Submit to WISE - Lab 10: Final Project: No later than 6pm on the day of the presentation, one of the partners should submit the following items to Wise as attachments to Lab 10.

   • UML Diagram: The final version, which is clean and clearly drawn, of your UML diagram for your entire program. Include authors on the diagram. If it was hand drawn, you can submit a photo or scan. Please make sure the photo/scan is readable.

   • Project Description: The final revised version of your 1/2 - 1 page type written project description (e.g. in Word). Include a summary of how the work was divided between the partners. It is not sufficient to just say you worked together on everything.

   • Code:

     • Comments: Your Java code should be well commented, including at the top of each file, lab name, program name, date, brief description of what the class does. Since you are working with a partner, it is important that you specify who wrote what. If one person wrote an entire class, their name should be listed as author at the top of the class. If the methods in a single class were done by different partners, then each method should specify an author. Some of the methods might be written collaboratively in which case the names of both partners should be listed. However, most classes or methods should be written predominately by a single person. It is not ok to just say that both people wrote everything together. The code implementation should be divided among both partners.
     • Formatting: Your Java code should be well formatted, i.e. proper indentation and line returns.
     • Netbeans Project: Zip together your entire Netbeans Project. The zip file should include all files necessary for running the program including data files and images. Older/unused java or data files should be deleted. Submit the zipped file as an attachment in WISE. If WISE complains about the size of the program or anything else, you can try deleting all .class and .jar files from your project before zipping.

>