Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Milestone 3 #99

Open
15 tasks
meagangardner opened this issue Mar 3, 2025 · 0 comments
Open
15 tasks

Milestone 3 #99

meagangardner opened this issue Mar 3, 2025 · 0 comments

Comments

@meagangardner
Copy link
Collaborator

This week you will continue developing your dashboard's functionality and design. Overall, this milestone is a bit lighter since it is quiz week.
App refinement: The goal by the end of this week is to have a fully functional and well-designed dashboard. That means that all the widgets should be hooked up and there should not be any obvious bugs. The layout should be polished and the design should be consistent. However, none of these things are expected to have production level polish yet. For example, it's OK if there are improvements that can be made to chart selections or widget functionality or that there is one special corner case that doesn't work in terms of functionality as long as these are detailed in your reflection. Everything should be great, but it doesn't need to be perfect.

Address Daniel's Feedback:

Break code into multiple files:

  • As your code base grows, it is now a good idea to break it into multiple files, instead of having a giant app.py file. You have already covered modularization earlier in the program, and we will talk about it in class this week in the context of dashboards (including how to make it work locally and on the deployed server), but generally you can put data preprocessing relating functions in one file, layout-related functions in another file, and split the server side into as many files as makes sense to you based on your apps functionality.

Reflection: In this section, your group should clearly document which additional parts of your proposal/sketch you have implemented in your dashboard since milestone 2 and explain what is not yet implemented.

  • For anything that you have done differently than in your proposal/sketch explain why (e.g. implementation difficulty, explanation for why the new approach is more effective, etc).
  • f there is some corner case that you are aware of is not working, you can document it here. However, most things should be working in the dashboard at this point.
  • You should explain if you have intentionally deviated from any of the best practices that we learned in 531 regarding effective visualizations.
  • Reflect on what you think your dashboard does well currently what its limitations are, and what are good potential future improvements and additions.
  • This section should not be more than 500 words and be written to the file reports/m3-reflection.md in your GitHub repo.

Get inspiration from your peers (Challenging)

  • For the challenging section of this milestone, you should find one aspect from another group that you also implement in your own dashboard, or use for inspiration to implement something similar. This could either be from the group one of you have reviewed or from another group whose dashboard you found inspiring.
  • For example, this could be that you saw how another group had hooked up the callbacks between widgets in a clever manner, that they are using a certain type of chart that you realize is more suitable for your data than the one you are currently using, or that they way they designed some aspect of their layout would work well in your dashboard too. It is not enough if it is a very minor things such as you like the color they used for their buttons, and picked the same color for yours (but if there are many small things, that could be fine). If you are unsure, you can reach out to me. To be clear, this is not about copying another groups work verbatim, but to get inspiration for how you can incorporate similar functionality or design after adapting it to the context of your own dashboard.
  • If you attempt the challenging question, you should write about what you did in the reflection document so that it is clear what to assess when grading. Include which group's dashboard you used for inspiration and why you think this approach is beneficial for your dashboard.
    Work Collaboratively on Github

Submission:

  • Same as last week: link-to-release.ipynb: Includes a single markdown cell with the link to your GitHub release for this milestone.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant