Project: Final Deliverable Due Wednesday 11/29/2023 11am ET
The final project deliverable is the implementation, available in github and deployed on Netlify and Heroku or render.com, and the documentation turned in to Canvas. It also includes poster and/or demos.
Project Implementation and Documentation
Your final team deliverable will be a “release” of your new feature on GitHub (with tests), and will be accompanied by a demo. You will submit the link of your hosted app on Canvas.
Contents
Your final team deliverable will include:
- The implementation of your new feature, deployed to Netlify + Heroku / Render.com
- Automated tests for your new feature
- A report that describes how to use your new feature
- A poster and/or demo
Accompanying the final team deliverable will be an individual reflection, which every student must submit on their own which will include your reflections on the evolution of your project concept, on the software engineering processes you used, and on your team’s dynamics and collaboration.
Submission Instructions
Code, documentation and Link
All apps will be deployed on Netlify and Heroku / Render (instructions for CI/CD pipeline setup are provided separately). After you have pushed all of your code (and documentation) to your team’s GitHub repository, create a release on GitHub, and apply the tag version final-submission. After your release is created, you’ll find that there is now a .zip that can be downloaded from GitHub that contains a snapshot of your entire repository. Download this zip file, unpack it, and follow the instructions that you provided in your README to double-check that the course staff will be able to run your project (this step is handy to make sure that you didn’t forget to include some key files in git). If needed, you can delete the release, make some changes, and re-release up until the deadline. Submit this zip file to Canvas under the assignment “Project: Code Submission” along with the link of your hosted app (in comments or a text file). Submit your report separately to Canvas, under the assignment “Project: Report”.
Project Poster & Demo
Each team will submit a poster. Your poster will be a single-page document, that will include the following aspects:
- Short description of the project (OK to reuse text from the project plan/report)
- Link to public demo site, link to source repo (OK to make the repo public now, or OK to leave as private)
- Short description of the technology stack and overall design decisions
- Short description of future work that could build on your project - additional features that you think could be interesting, or ideas for refactoring the code.
- Screenshots of the feature, visually demonstrating the main functionality that you implemented.
We’ve created a sample poster for the “Conversation Areas” feature, which you might find useful in deciding how to format your poster. It’s fine to use a different aspect ratio (e.g. portrait instead of landscape), and there are no specific requirements for font size or amount of text. Please try to create a document that you feel represents your project, imagine your target audience as a recruiter for a software engineering role: your goal is to demonstrate that you have some experience working on some non-trivial software engineering project.
In addition, some sections will have live (in-person) demos and others may ask you to record a demo video. Details for project demos and/or presentations will be provided during class by each instructor (and may vary from section to section). Posters and/or demo videos and/or presentations will be submitted on Canvas, under the assignment “Project: Poster / Demo”.
Individual Reflection
Create a PDF of your reflection, and submit it to Canvas, under the assignment “Project: Individual Reflection”.
Grading
Details on grading may be found at Project Grading