v1.8.1: Improve on SEO: add favicon rule as googlebot continuously sends requests for it

Author: fabriziomiano

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## My Pledge
+
+In the interest of fostering an open and welcoming environment, I as the
+maintainer pledge to making participation in my project and
+my community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## My Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## My Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

Dockerfile

@@ -16,10 +16,14 @@ WORKDIR /opt/app
 # This is only for testing purposes as $PORT is automatically set by Heroku
 #ENV PORT 5000
 
-# Environment variables that need to be set locally
-# to retrieve the bar-chart races from mongoDB
-#ENV COLLECTION_NAME changeme
-#ENV MONGO_URI changeme
+# Database-related env vars: will need to be set on Heroku
+ENV MONGO_URI changeme
+ENV BAR_CHART_COLLECTION changeme
+ENV NATIONAL_DATA_COLLECTION changeme
+ENV REGIONAL_DATA_COLLECTION changeme
+ENV PROVINCIAL_DATA_COLLECTION changeme
+ENV LATEST_REGIONAL_DATA_COLLECTION changeme
+ENV LATEST_PROVINCIAL_DATA_COLLECTION changeme
 
 # Run the app.  CMD is required to run on Heroku
 CMD gunicorn --bind 0.0.0.0:$PORT wsgi:app

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Fabrizio Miano
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

app/__init__.py

@@ -18,16 +18,17 @@ def create_app():
     app.config["MONGO_URI"] = MONGO_URI
     mongo.init_app(app)
     babel = Babel(app)
-    app.config['SITEMAP_INCLUDE_RULES_WITHOUT_PARAMS'] = True
+    app.config["SITEMAP_INCLUDE_RULES_WITHOUT_PARAMS"] = True
     sitemap.init_app(app)
     set_error_handlers(app)
-    set_robots_route(app)
+    set_robots_txt_rule(app)
+    set_favicon_rule(app)
 
     @babel.localeselector
     def get_locale():
         return request.accept_languages.best_match(LANGUAGES.keys())
 
-    app.config['BABEL_TRANSLATION_DIRECTORIES'] = os.path.join(
+    app.config["BABEL_TRANSLATION_DIRECTORIES"] = os.path.join(
         app.root_path, TRANSLATION_DIRNAME
     )
 
@@ -40,7 +41,7 @@ def add_header(r):
         r.headers["Cache-Control"] = "no-cache, no-store, must-revalidate"
         r.headers["Pragma"] = "no-cache"
         r.headers["Expires"] = "0"
-        r.headers['Cache-Control'] = 'public, max-age=0'
+        r.headers["Cache-Control"] = "public, max-age=0"
         return r
 
     from .ui import dashboard
@@ -66,7 +67,15 @@ def server_error(e):
         return render_template("errors/generic.html", error=e)
 
 
-def set_robots_route(app):
-    @app.route('/robots.txt')
+def set_robots_txt_rule(app):
+    @app.route("/robots.txt")
     def robots_txt():
         return send_from_directory(app.static_folder, request.path[1:])
+
+
+def set_favicon_rule(app):
+    @app.route("/favicon.ico")
+    def favicon():
+        return send_from_directory(
+            os.path.join(app.root_path, "static"),
+            "favicon.ico", mimetype="image/vnd.microsoft.icon")

app/static/favicon.ico

@@ -30,10 +30,10 @@
     <meta property="og:locale" content="en_US"/>
     <meta property="og:locale:alternate" content="it-IT"/>
     <title>{{ page_title }}</title>
-    <link rel="apple-touch-icon" href="{{ url_for('static', filename='img/virussketch.png') }}" sizes="180x180">
-    <link rel="icon" href="{{ url_for('static', filename='img/virussketch.png') }}" sizes="32x32" type="image/png">
-    <link rel="icon" href="{{ url_for('static', filename='img/virussketch.png') }}" sizes="16x16" type="image/png">
+    <link rel="apple-touch-icon" href="{{ url_for('static', filename='img/virussketch_180.png') }}" sizes="180x180">
     <link rel="mask-icon" href="{{ url_for('static', filename='img/virussketch.png') }}" color="#563d7c">
+    <link rel="icon" href="{{ url_for('static', filename='img/virussketch_32.png') }}" sizes="32x32" type="image/png">
+    <link rel="icon" href="{{ url_for('static', filename='img/virussketch_16.png') }}" sizes="16x16" type="image/png">
     <link rel="icon" href="{{ url_for('static', filename='img/virussketch.png') }}">
     <link href="https://cdn.datatables.net/1.10.20/css/dataTables.bootstrap4.min.css" rel="stylesheet" crossorigin="anonymous" />
     <link href="https://cdnjs.cloudflare.com/ajax/libs/jqueryui/1.12.1/jquery-ui.min.css" rel="stylesheet"/>