Client Project Wrap Up
It's time to wrap up the client project. This task is one of your most critical activities. There's more involved than just stopping. This is where you prepare the project for future developers. That includes:
- Fixing the easy bugs, and documenting the hard ones.
- Cleaning out unused code, and anything specific to you, e.g., keys tied to specific developer accounts.
- Updating all the components and testing.
- Documenting all the bits the next developer team needs to know.
See the slides on finishing a project for the various actions that you need to take.
Create or edit your project's README.md file to document the above and anything else that's relevant. Use Github markdown to format and create working links. Document
- how to download and install the code
- how to build and deploy the app
- don't forget steps like creating accounts at Firebase, Heroku, etc., and where to put app keys in the configuration files
- platform constraints, both for development and deployment
- dependencies not handle by the app's package manager
- known bugs not fixed, and specific limitations of the app
Submit the URL of your README.md to the assignment on Canvas.
Follow the pattern of other github projects:
The README template is OK to give you an empty shell, but you need to look at the above to see how to give setup instructions, known dependencies and deficiencies, and so on.