From 4269debd28ba1defdef895db707738fecab77d3f Mon Sep 17 00:00:00 2001 From: ananya173147 Date: Tue, 17 Oct 2023 01:28:31 -0400 Subject: [PATCH 1/2] add highlight box for visibility --- src/recommenderapp/static/stylesheet.css | 10 ++++++++++ src/recommenderapp/templates/landing_page.html | 14 +++++++------- 2 files changed, 17 insertions(+), 7 deletions(-) diff --git a/src/recommenderapp/static/stylesheet.css b/src/recommenderapp/static/stylesheet.css index 5f54cfdd5..921a6be0b 100644 --- a/src/recommenderapp/static/stylesheet.css +++ b/src/recommenderapp/static/stylesheet.css @@ -4,6 +4,16 @@ color: azure !important; } +.highlighted-section { + background-color: black; + color: white; + width: 21rem; + height: 4.5rem; + margin: auto; + display: flex; + align-items: center; + flex-direction: column; +} body { background-image: url("224299.jpg"); diff --git a/src/recommenderapp/templates/landing_page.html b/src/recommenderapp/templates/landing_page.html index 1f96d4f3b..8c7da925c 100644 --- a/src/recommenderapp/templates/landing_page.html +++ b/src/recommenderapp/templates/landing_page.html @@ -23,7 +23,7 @@
-
+




🎬 PopcornPicks: Pick a Movie! 🎬


Discover personalized movie recommendations by selecting up to 5 of your favorite films. @@ -31,12 +31,12 @@

🎬 PopcornPicks: Pick a Movie! 🎬

Create a watchlist and have it conveniently sent to your email.
Enjoy movies at your own pace, on your terms. -

- - -









- Made with ❤️ by PopcornPicks
- MIT License Copyright (c) 2023 PopcornPicks +


+

+
+

Made with ❤️ by PopcornPicks

+ MIT License Copyright (c) 2023 PopcornPicks +
From 5fce4758dde305e338e1a4f956614b54f32152ba Mon Sep 17 00:00:00 2001 From: ananya173147 Date: Tue, 17 Oct 2023 01:50:30 -0400 Subject: [PATCH 2/2] add placeholder scorecard --- proj2/score_card.md | 106 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 106 insertions(+) create mode 100644 proj2/score_card.md diff --git a/proj2/score_card.md b/proj2/score_card.md new file mode 100644 index 000000000..c14b8555e --- /dev/null +++ b/proj2/score_card.md @@ -0,0 +1,106 @@ +Project: [PopcornPicks](https://github.com/adipai/PopcornPicks) +Total score :71 +|Item |Assessment|Evidence | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +|Video |3 |See the main Readme.md file : https://www.youtube.com/watch?v=OSjpryqI1RQ | +|Workload is spread over the whole team (one team member is often Xtimes more productive than the others...but nevertheless, here is a track record that everyone is contributing a lot) |2 |Commits by all team members seen, but slight imbalance in workload with couple of members not contributing enough : https://github.com/git-ankit/MovieRecommender/graphs/contributors| +|Number of commits |3 |249 commits - decent number for a small project | +|Number of commits: by different people |2 |Commits are done but workload doesn't seem to be distributed +enough | +|Issues reports: there are many |3 |28 issues seen | +|Issues are being closed |3 |26 issues closed | +|DOI badge: exists |3 |Badges exist, works | +|Docs: doco generated, format not ugly |1 |Documentation is written but not very clearly : https://github.com/git-ankit/MovieRecommender/wiki/Documentation | +|Docs: what: point descriptions of each class/function (in isolation) |2 |Code is not well-documented and not modular : missing doc strings too | +|Docs: how: for common use cases X,Y,Z mini-tutorials showing worked examples on how to do X,Y,Z |3 |Seen in the video and the gif | +|Docs: why: docs tell a story, motivate the whole thing, deliver a punchline that makes you want to rush out and use the thing |2 |Can be seen in the video and their main repo's readme but not too catchy +a punchline that makes me want to rush out to use their product | +|Docs: short video, animated, hosted on your repo. That convinces people why they want to work on your code. |2 |Gifs and video exist but not too catchy | +|Use of version control tools |3 |Git is used throughout their project | +|Use of style checkers |3 |https://github.com/git-ankit/MovieRecommender/blob/master/.travis.yml | +|Use of code formatters. |0 |https://github.com/git-ankit/MovieRecommender/blob/master/.travis.yml | +|Use of syntax checkers. |3 |https://github.com/git-ankit/MovieRecommender/blob/master/.travis.yml | +|Use of code coverage |3 |100% code coverage | +|Other automated analysis tools |0 |Can't see any such analysis tools in their Github action workflows | +|Test cases exist |3 |Test-cases exsit: https://github.com/Team-Glare/calorieApp_server/blob/main/test_app.py | +|Test cases are routinely executed |0 |Can't see in workflows : https://github.com/Team-Glare/calorieApp_server/actions | +|The files CONTRIBUTING.md lists coding standards and lots of tips on how to extend the system without screwing things up |3 |Well written with all required info : https://github.com/git-ankit/MovieRecommender/blob/master/CONTRIBUTING.md | +|Issues are discussed before they are closed |3 |All closed issues have discussions : https://github.com/git-ankit/MovieRecommender/issues?q=is%3Aissue+is%3Aclosed | +|Chat channel: exists |3 |Issues discussed | +|Test cases: a large proportion of the issues related to handling failing cases |3 |3 specific issues were addressed to failing test cases! | +|Evidence that the whole team is using the same tools: everyone can get to all tools and files |3 |Requirements.txt mention correct versions of the libraries used | +|Evidence that the whole team is using the same tools (e.g. config files in the repo, updated by lots of different people) |3 | | +|Evidence that the whole team is using the same tools (e.g. tutor can ask anyone to share screen, they demonstrate the system running on their computer) |3 | | +|Evidence that the members of the team are working across multiple places in the code base |3 |Seen in contributor insights : [https://github.com/Team-Glare/calorieApp_server/graphs/contributors ](https://github.com/git-ankit/MovieRecommender/graphs/contributors) | +|Short release cycles |3 |3 versions exist - https://github.com/git-ankit/MovieRecommender/releases | +| | | | +|Does your website and documentation provide a clear, high-level overview of your software? |Y |Very elaborate documentation of each command | +|Does your website and documentation clearly describe the type of user who should use your software? |Y | | +|Do you publish case studies to show how your software has been used by yourself and others? |Y | | +|Is the name of your project/software unique? |Y |Project name is a unique acronym | +|Is your project/software name free from trademark violations? |Y | | +|Is your software available as a package that can be deployed without building it? |Y | | +|Is your software available for free? |Y | | +|Is your source code publicly available to download, either as a downloadable bundle or via access to a source code repository? |Y | | +|Is your software hosted in an established, third-party repository likeGitHub (https://github.com) |Y |Publicly available : https://github.com/git-ankit/MovieRecommender | +|Is your documentation clearly available on your website or within your software? |Y |Very well written documentation and Readme | +|Does your documentation include a "quick start" guide, that provides a short overview of how to use your software with some basic examples of use? |Y |Very well written documentation and Readme | +|If you provide more extensive documentation, does this provide clear, step-by-step instructions on how to deploy and use your software? |Y |Very well written documentation and Readme | +|Do you provide a comprehensive guide to all your software’s commands, functions and options? |Y |Very well written documentation and Readme | +|Do you provide troubleshooting information that describes the symptoms and step-by-step solutions for problems and error messages? |N | | +|If your software can be used as a library, package or service by other software, do you provide comprehensive API documentation? |N | | +|Do you store your documentation under revision control with your source code? |Y | | +|Do you publish your release history e.g. release data, version numbers, key features of each release etc. on your web site or in your documentation? |Y |https://github.com/git-ankit/MovieRecommender/tags | +|Does your software describe how a user can get help with using your software? |Y | | +|Does your website and documentation describe what support, if any, you provide to users and developers? |Y | | +|Does your project have an e-mail address or forum that is solely for supporting users? |N | | +|Are e-mails to your support e-mail address received by more than one person? |N | | +|Does your project have a ticketing system to manage bug reports and feature requests? |Y |Issues are discussed and check Contribution.md | +|Is your project's ticketing system publicly visible to your users, so they can view bug reports and feature requests? |Y |Bugs are logged as issues on the Github repository | +|Is your software’s architecture and design modular? |N |The code isn't well written and lacks comments and explanation of every function made | +|Does your software use an accepted coding standard or convention? |Y | | +|Does your software allow data to be imported and exported using open data formats? e.g. GIF, SVG, HTML, XML, tar, zip, CSV, JSON, NetCDF, or domain specific ones |Y | | +|Does your software allow communications using open communications protocols? e.g. HTTP, FTP, XMPP, SOAP over HTTP, or domain-specific ones |Y | | +|Is your software cross-platform compatible? e.g. does it run under two or more of Windows, Unix/Linux and Mac OS X, or can be used from within two or more of Internet Explorer, Chrome, Firefox and Safari?|Y | | +|Does your software adhere to appropriate accessibility conventions or standards? |Y | | +|Does your documentation adhere to appropriate accessibility conventions or standards? |Y | | +|Is your source code stored in a repository under revision control? |Y | | +|Is each source code release a snapshot of the repository? |Y | | +|Are releases tagged in the repository? |Y |https://github.com/git-ankit/MovieRecommender/releases | +|Is there a branch of the repository that is always stable? (i.e. tests always pass, code always builds successfully) |Y |the main branch is always stable | +|Do you back-up your repository? |Y | | +|Do you provide publicly-available instructions for building your software from the source code? |Y |Well written instructions for building the software | +|Can you build, or package, your software using an automated tool? |Y |Setup.py provided | +|Do you provide publicly-available instructions for deploying your software? |Y | | +|Does your documentation list all third-party dependencies? |Y | | +|Does your documentation list the version number for all third-party dependencies? |Y | | +|Does your software list the web address, and licences for all third-party dependencies and say whether the dependencies are mandatory or optional? |Y | | +|Can you download dependencies using a dependency management tool or package manager? |Y | | +|Do you have tests that can be run after your software has been built or deployed to show whether the build or deployment has been successful? |Y |Test cases exist | +|Do you have an automated test suite for your software? |Y |test cases file exist | +|Do you have a framework to periodically (e.g. nightly) run your tests on the latest version of the source code? |N |No existing workflow runs | +|Do you use continuous integration, automatically running tests whenever changes are made to your source code? |N |No workflows exist | +|Are your test results publicly visible |Y | | +|Are all manually-run tests documented? |Y | | +|Does your project have resources (e.g. blog, Twitter, RSS feed, Facebook page, wiki, mailing list) that are regularly updated with information about your software? |N |No other resource other than github discussions(might have one but not mentioned) | +|Does your website state how many projects and users are associated with your project? |N | | +|Do you provide success stories on your website? |N | | +|Do you list your important partners and collaborators on your website? |N | | +|Do you list your project's publications on your website or link to a resource where these are available? |N | | +|Do you list third-party publications that refer to your software on your website or link to a resource where these are available? |N | | +|Can users subscribe to notifications to changes to your source code repository? |N | | +|If your software is developed as an open source project (and, not just a project developing open source software), do you have a governance model? |N | | +|Do you accept contributions (e.g. bug fixes, enhancements, documentation updates, tutorials) from people who are not part of your project? |Y |See Contributing.md | +|Do you have a contributions policy? |Y | | +|Is your contributions' policy publicly available? |Y | | +|Do contributors keep the copyright/IP of their contributions? |N | | +|Does your website and documentation clearly state the copyright owners of your software and documentation? |N | | +|Does each of your source code files include a copyright statement? |N | | +|Does your website and documentation clearly state the licence of your software? |Y | | +|Is your software released under an open source licence? |Y |MIT License | +|Is your software released under an OSI-approved open-source licence? |Y | | +|Does each of your source code files include a licence header? |N | | +|Do you have a recommended citation for your software? |N | | +|Does your website or documentation include a project roadmap (a list of project and development milestones for the next 3, 6 and 12 months)? |N | | +|Does your website or documentation describe how your project is funded, and the period over which funding is guaranteed? |N | | +|Do you make timely announcements of the deprecation of components, APIs, etc.? |N | |