- Student Name:
- Github Username:
- Semester:
- Course:
General overview of the project, what you did, why you did it, etc.
Highlight some key features of this project that you want to show off/talk about/focus on.
How do we run your project? What should we do to see it in action? - Note this isn't installing, this is actual use of the project.. If it is a website, you can point towards the gui, use screenshots, etc talking about features.
If we wanted to run this project locally, what would we need to do? If we need to get API key's include that information, and also command line startup commands to execute the project. If you have a lot of dependencies, you can also include a requirements.txt file, but make sure to include that we need to run pip install -r requirements.txt or something similar.
Go over key aspects of code in this section. Both link to the file, include snippets in this report (make sure to use the coding blocks). Grading wise, we are looking for that you understand your code and what you did.
Key aspects could include pieces that your struggled on and/or pieces that you are proud of and want to show off.
Explain how you documented running the project, and what we need to look for in your repository (text output from the project, small videos, links to videos on youtube of you running it, etc)
How did you test your code? What did you do to make sure your code was correct? If you wrote unit tests, you can link to them here. If you did run tests, make sure you document them as text files, and include them in your submission.
Make it easy for us to know you ran the project and tested the project before you submitted this report!
Focus on what you didn't get to do, and what you would do if you had more time, or things you would implement in the future.
Write at least a paragraph about your experience in this course. What did you learn? What do you need to do to learn more? Key takeaways? etc.