# Final Project

The climax of this course is its final project. The final project is your opportunity to take your newfound savvy with programming out for a spin and develop your very own piece of software. So long as your project draws upon the course’s lessons, the nature of your project is entirely up to you, albeit subject to the staff’s approval. You may implement your project in any language(s) as long as the staff approves. You are welcome to utilize any infrastructure, provided the staff ultimately has access to any hardware and software that your project requires. All that we ask is that you build something of interest to you, that you solve an actual problem, that you impact campus, or that you change the world. Strive to create something that outlives this course.

Inasmuch as software development is rarely a one-person effort, you are allowed an opportunity to collaborate with one or two classmates for this final project. Needless to say, it is expected that every student in any such group contribute equally to the design and implementation of that group’s project. Moreover, it is expected that the scope of a two- or three-person group’s project be, respectively, twice or thrice that of a typical one-person project. A one-person project, mind you, should entail more time and effort than is required by each of the course’s problem sets. Although no more than three students may design and implement a given project, you are welcome to solicit advice from others, so long as you respect the course’s policy on academic honesty.

Extensions on the final project are not ordinarily granted, except in cases of emergency.

## Ideas

Here are just some of the possibilities. Discuss any and all with the the staff! And if you’d like to solicit collaborators for an idea you have, do post in Ed!

• a web-based application using JavaScript, Python, and SQL
• an iOS app using Swift
• an Android app using Java
• a Chrome extension using JavaScript
• a command-line program using C
• a hardware-based application for which you program some device
• a web-based application using Node.js
• a game using Lua with LÖVE

## Combining Courses

If taking some other course this semester that has a final project, you are welcome and encouraged to combine this course’s project and that course’s project into one, toward an end of applying lessons learned in CS50 to some other field, so long as the joint project satisfies this course’s and that course’s expectations. Before pursuing a joint project, though, you must disclose to both courses and receive approval from both courses.

## Specifications

Extensions on the final project are not granted, except in cases of emergency.

### Proposal

due by

The proposal is your opportunity to receive approval and counsel from the staff before you proceed to design. If collaborating with one or two classmates, each of you should submit a proposal, even if identical.

The staff will either approve your proposal or require modifications on your part for subsequent approval. Your proposal, even if approved, is not binding; you may alter your plan at any point, provided you obtain the staff’s approval for any modifications. Projects submitted without approval may not receive credit.

#### How to Submit

Here’s how to complete your proposal.

1. Execute cd to ensure that you’re in ~/ (i.e., your home directory).
2. If you haven’t already, execute mkdir project to make (i.e., create) a directory called project in your home directory.
3. Execute cd project to change into (i.e., open) that directory.
4. Execute wget https://cdn.cs50.net/2020/fall/project/proposal.zip to download a (compressed) ZIP file.
5. Execute unzip proposal.zip to uncompress that file.
6. Execute rm proposal.zip followed by yes or y to delete that ZIP file.
7. Execute ls. You should see a directory called proposal, which was inside of that ZIP file.
8. Execute cd proposal to change into that directory.
9. Execute ls. You should see a file called README.md therein.

Edit that file in CS50 IDE, answering the questions therein. To submit your proposal, follow these instructions.

1. Download your proposal’s README.md file by control-clicking on the file in CS50 IDE’s file browser and choosing Download.
2. Go to CS50’s Gradescope page.
3. Click “Final Project: Proposal”.
4. Drag and drop your README.md file to the area that says “Drag & Drop”.

You should see a message that says “Final Project: Proposal submitted successfully!”

### Status Report

due by

Not only is the status report intended to keep the staff apprised of your progress, it is an opportunity to keep yourself on track. If collaborating with one or two classmates, each of you should submit a status report, even if identical.

#### How to Submit

1. Accept the Status Report assignment via GitHub Classroom
2. After about a minute, refresh the page and ensure you see “You’re ready to go!”.
3. Log into code.cs50.io, click on your terminal window, and execute cd by itself. You should find that your terminal window’s prompt resembles the below:
$ Next execute get50 status-report  in order to download a directory called status-report into your codespace. Then execute cd status-report  in order to change into that directory. Your prompt should now resemble the below: status-report/$


Execute ls by itself, and you should see a status-report.md file. If you run into any trouble, follow these same steps again and see if you can determine where you went wrong!

Edit your status-report.md file in VS Code, answering the questions therein. To submit your proposal, follow these instructions.

1. Download your status-report.md file by control-clicking or right-clicking on the file in VS Code’s file browser and choosing Download.
2. Go to CS50’s Gradescope page.
3. Click “Final Project: Status Report”.
4. Drag and drop your status-report.md file to the area that says “Drag & Drop”.

You should see a message that says “Final Project: Status Report submitted successfully!”

### Implementation

due by

Ultimately due are implementation and documentation of your final project. Your submission thereof must include all of the below.

1. Documentation for your project in the form of a Markdown file called README.md. This documentation is to be a user’s manual for your project. Though the structure of your documentation is entirely up to you, it should be incredibly clear to the staff how and where, if applicable, to compile, configure, and use your project. Your documentation should be at least several paragraphs in length. It should not be necessary for us to contact you with questions regarding your project after its submission. Hold our hand with this documentation; be sure to answer in your documentation any questions that you think we might have while testing your work.
2. A “design document” for your project in the form of a Markdown file called DESIGN.md that discusses, technically, how you implemented your project and why you made the design decisions you did. Your design document should be at least several paragraphs in length. Whereas your documentation is meant to be a user’s manual, consider your design document your opportunity to give the staff a technical tour of your project underneath its hood.
3. Any and all files required to run your software (even if intended for some infrastructure other than CS50 IDE), including source code as well as, if applicable, configuration files, Makefiles, sample inputs, SQLite databases, and so forth. Needless to say, all source code should be thoroughly commented.
4. A short video (that’s no more than 2 minutes in length) in which you present your project to the world, as with slides, screenshots, voiceover, and/or live action, ideally with you yourself appearing in the video. Your video should somehow include your project’s title, your name and year, your college and major, and any other details that you’d like to convey to viewers. See CS171’s tips on how to make a “screencast” though you’re welcome to use an actual camera. Upload your video to YouTube as “public” or “unlisted” and include the URL of the video in your README.md file.

#### How to Submit

If you have collaborated with one or two other students, each of you should submit via this same process.

If your project requires (for execution and testing) hardware or software other than that offered by VS Code, be sure that the the staff are aware of and have approved your project’s needs.

##### Step 1 of 2
1. Download a ZIP file of your final project by running zip -r project.zip * within your project’s folder in VS Code. Find the project.zip file in the file browser and right-click to choose Download. (If you created your final project outside of VS Code, you should still create a ZIP file of the project folder.)
2. Go to CS50’s Gradescope page.
3. Click “Final Project: Implementation”.
4. Drag and drop your ZIP file to the area that says “Drag & Drop”.