Merge and deploy latest

.github/workflows/ci.yaml

@@ -0,0 +1,43 @@
+name: CI
+on:
+  pull_request:
+  push:
+jobs:
+  build-tag-push-deploy:
+    runs-on: ubuntu-latest
+    if: >
+      github.ref == 'refs/heads/main' ||
+      github.ref == 'refs/heads/dev'
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v1
+        with:
+          registry: ghcr.io
+          username: cmu-delphi-deploy-machine
+          password: ${{ secrets.CMU_DELPHI_DEPLOY_MACHINE_PAT }}
+      - name: Build, tag, and push image to GitHub Container Registry
+        id: image
+        run: |
+          baseRef="${GITHUB_REF#*/}"
+          baseRef="${baseRef#*/}"
+          case "${baseRef}" in
+          main)
+            image_tag="latest"
+            ;;
+          *)
+            image_tag="${baseRef//\//_}" # replace `/` with `_` in branch name
+            ;;
+          esac
+          cd ${{ github.workspace }}
+          echo "using tag: --${image-tag}--"
+          docker build -t ghcr.io/${{ github.repository }}:${image_tag} --file ./devops/Dockerfile .
+          docker push ghcr.io/${{ github.repository }}:${image_tag}
+          echo "IMAGE_TAG=${image_tag}" >> $GITHUB_OUTPUT
+      - name: Trigger smee.io webhook to deploy new container image
+        run: |
+          curl -H "Authorization: Bearer ${{ secrets.DELPHI_DEPLOY_WEBHOOK_TOKEN }}" \
+               -X POST ${{ secrets.DELPHI_DEPLOY_WEBHOOK_URL }} \
+               -H "Content-Type: application/x-www-form-urlencoded" \
+               -d "repository=ghcr.io/${{ github.repository }}&tag=${{ steps.image.outputs.IMAGE_TAG }}"

README.md

@@ -1,12 +1,39 @@
-# Status
-
-[![Deploy Status](https://delphi.midas.cs.cmu.edu/~automation/public/github_deploy_repo/badge.php?repo=cmu-delphi/www-crowdcast)](#)
 
 # About
 
-The Crowdcast website for collecting flu forecasts.
+The Crowdcast website for collecting flu forecasts. (Previously known as
+Epicast.)
+
+The site is live at <https://delphi.cmu.edu/crowdcast>.
+
+# Branches
+
+The website is deployed to two separate environments: `staging` and `production`. The code for those environments is kept in the
+[`dev`](https://github.com/cmu-delphi/www-epicast/tree/dev) and
+[`main`](https://github.com/cmu-delphi/www-epicast/tree/main) branches,
+respectively.
+
+## `dev` branch
+
+The `dev` branch is deployed to a Delphi-internal development environment where we can iterate quickly without worry of breaking the production site.
+
+## `main` branch
+
+The `main` branch is deployed to a public-facing production environment. It
+should contain only tested and reliable code.
+
+## Process
+
+**`main` should not be updated while a forecasting round is active** (i.e.
+Friday through Monday), except in case of a critical bugfix.
+
+Basic develop changes -> deploy/review in staging -> release to production workflow:
+
+- Start by creating a **[bug|fix|feature|etc]** branch based on `dev`.
+- Make a PR and tag a reviewer with your changes against `dev`. Once apporved and merged this will trigger CI to deploy the application at https://staging.delphi.cmu.edu/crowdcast.
+- Once staging is reviewed and deemed acceptable, make a PR against `main` and tag a reviewer. Once this is approved and merged the production version of the application will be available at https://delphi.cmu.edu/crowdcast
 
-The site is live at:
-- https://delphi.cmu.edu/crowdcast
+# Development
 
-A live demo is available at http://demo.epicast.net/ (User ID is `00000000`)
+For developing the website, see the
+[epicast development guide](docs/epicast_development.md).

deploy.json

@@ -7,42 +7,35 @@
     {
       "type": "move",
       "src": "site/.htaccess",
-      "dst": "/var/www/html/crowdcast/.htaccess",
+      "dst": "/var/www/html/cc-test/.htaccess",
       "add-header-comment": false
     },
-    "// service worker",
-    {
-      "type": "move",
-      "src": "site/sw.js",
-      "dst": "/var/www/html/crowdcast/sw.js",
-      "add-header-comment": true
-    },
     "// web sources",
     {
       "type": "move",
       "src": "site/",
-      "dst": "/var/www/html/crowdcast/",
+      "dst": "/var/www/html/cc-test/",
       "match": "^.*\\.php$",
       "add-header-comment": true
     },
     {
       "type": "move",
       "src": "site/common/",
-      "dst": "/var/www/html/crowdcast/common/",
+      "dst": "/var/www/html/cc-test/common/",
       "match": "^.*\\.php$",
       "add-header-comment": true
     },
     {
       "type": "move",
       "src": "site/css/",
-      "dst": "/var/www/html/crowdcast/css/",
-      "match": "^.*\\.(css|php)$",
+      "dst": "/var/www/html/cc-test/css/",
+      "match": "^.*\\.(php)$",
       "add-header-comment": true
     },
     {
       "type": "move",
       "src": "site/js/",
-      "dst": "/var/www/html/crowdcast/js/",
+      "dst": "/var/www/html/cc-test/js/",
       "match": "^.*\\.js$",
       "add-header-comment": true
     },
@@ -51,21 +44,21 @@
     {
       "type": "move",
       "src": "site/images/flags/",
-      "dst": "/var/www/html/crowdcast/images/flags/",
+      "dst": "/var/www/html/cc-test/images/flags/",
       "match": "^.*\\.png$"
     },
     "// tutorials",
     {
       "type": "move",
       "src": "site/images/",
-      "dst": "/var/www/html/crowdcast/images/",
+      "dst": "/var/www/html/cc-test/images/",
       "match": "^.*\\.(gif|mp4)$"
     },
     "// benchmark data",
     {
       "type":"move",
       "src":"site/data/",
-      "dst":"/var/www/html/crowdcast/data/",
+      "dst":"/var/www/html/cc-test/data/",
       "match":"^.*\\.csv$"
     }
   ]

dev/docker/database/epicast/Dockerfile

@@ -0,0 +1,19 @@
+# start with the `delphi_database` image
+FROM delphi_database
+
+# create the `epicast2` database
+ENV MYSQL_DATABASE epicast2
+
+# create the `epi` user account with a development-only password
+ENV MYSQL_USER user
+ENV MYSQL_PASSWORD pass
+
+# provide DDL which will create empty tables at container startup
+# note that files are executed in order of filename alphabetically, so here
+# destination files are named such that table definitions are executed prior to
+# data insertions
+COPY repos/delphi/www-epicast/src/ddl/epicast2.sql /docker-entrypoint-initdb.d/0_epicast2.sql
+COPY repos/delphi/www-epicast/src/ddl/development_data.sql /docker-entrypoint-initdb.d/1_development_data.sql
+
+# ensure files are readable at runtime
+RUN chmod o+r /docker-entrypoint-initdb.d/*

dev/docker/database/epicast/README.md

@@ -0,0 +1,27 @@
+# `delphi_database_epicast`
+
+This image extends Delphi's database by:
+
+- adding the `epi` user account
+- adding the `epicast2` database
+- creating and minimally populating tables in `epicast2`
+
+To start a container from this image, run:
+
+```bash
+docker run --rm -p 13306:3306 \
+  --network delphi-net --name delphi_database_epicast \
+  delphi_database_epicast
+```
+
+For debugging purposes, you can interactively connect to the database inside
+the container using a `mysql` client (either installed locally or supplied via
+a docker image) like this:
+
+```bash
+mysql --user=user --password=pass --port 13306 --host 127.0.0.1 epicast2
+```
+
+Note that using host `localhost` may fail on some platforms as mysql will
+attempt, and fail, to use a Unix socket. Using `127.0.0.1`, which implies
+TCP/IP, works instead.

dev/docker/web/epicast/Dockerfile

@@ -0,0 +1,30 @@
+# start with the `delphi_web` image
+FROM delphi_web
+
+# enable mod_rewrite, aka RewriteEngine
+RUN a2enmod rewrite
+
+# enable mod_headers
+RUN a2enmod headers
+
+# create an empty htpasswd file
+RUN touch /var/www/passwords
+
+# deploy the Epicast website (see `www-epicast/deploy.json`)
+# deploy files in an order that tries to take advantage of build caching
+
+COPY repos/delphi/www-epicast/site/images/* /var/www/html/images/
+COPY repos/delphi/www-epicast/site/images/flags/* /var/www/html/images/flags/
+COPY repos/delphi/www-epicast/site/data/* /var/www/html/data/
+
+COPY repos/delphi/www-epicast/site/css/* /var/www/html/css/
+COPY repos/delphi/www-epicast/site/js/*.js /var/www/html/js/
+COPY repos/delphi/www-epicast/site/js/us-map /var/www/html/js/us-map
+COPY repos/delphi/www-epicast/site/common/* /var/www/html/common/
+COPY repos/delphi/www-epicast/site/*.php /var/www/html/
+
+# point to the local development database (overwrites `common/settings.php`)
+COPY repos/delphi/www-epicast/dev/docker/web/epicast/assets/settings.php /var/www/html/common/
+
+# ensure files are readable at runtime
+RUN chmod o+r -R /var/www/html

dev/docker/web/epicast/README.md

@@ -0,0 +1,24 @@
+# `delphi_web_epicast`
+
+This image starts with Delphi's web server and adds the sources necessary for
+hosting the Epicast website. It further extends Delphi's web server by:
+
+- enabling the `mod_rewrite` extension
+- enabling the `mod_headers` extension
+- creating an empty `htpasswd` file
+
+This image includes the file
+[`settings.php`](assets/settings.php), which points to a local
+container running the
+[`delphi_database_epicast` image](../../database/epicast/README.md).
+
+To start a container from this image, run:
+
+```bash
+docker run --rm -p 10080:80 \
+  --network delphi-net --name delphi_web_epicast \
+  delphi_web_epicast
+```
+
+You should be able to login and interact with the website (e.g. submitting
+predictions) by visiting `http://localhost:10080/` in a web browser.

dev/docker/web/epicast/assets/settings.php

@@ -0,0 +1,15 @@
+<?php
+
+/* Settings and secrets for local development of the Epicast website. */
+
+$dbHost = 'delphi_database_epicast';
+$dbPort = 3306;
+$dbUser = 'user';
+$dbPass = 'pass';
+$dbName = 'epicast2';
+
+$epicastAdmin = array(
+   'name' => 'Delphi Developer',
+   'email' => 'fake_email_address',
+);
+?>

devops/Dockerfile

@@ -0,0 +1,28 @@
+# start with a standard php7+apache image
+# based on https://github.com/cmu-delphi/operations
+FROM php:7-apache
+LABEL org.opencontainers.image.source = "https://github.com/cmu-delphi/www-epicast"
+
+
+# use PHP's recommended configuration
+RUN mv "$PHP_INI_DIR/php.ini-production" "$PHP_INI_DIR/php.ini"
+
+# install and enable PHP's `mysqli` extension
+RUN docker-php-ext-install mysqli && \
+    docker-php-ext-enable mysqli
+
+# use delphi's timezome
+RUN ln -s -f /usr/share/zoneinfo/America/New_York /etc/localtime && \
+    sed -i $PHP_INI_DIR/php.ini -e 's/^;date.timezone =$/date.timezone = "America\/New_York"/'
+# enable mod_rewrite, aka RewriteEngine
+RUN a2enmod rewrite && a2enmod headers
+
+ENV EPICAST_DB_HOST 'localhost'
+ENV EPICAST_DB_PORT '3306'
+ENV EPICAST_DB_USER 'user'
+ENV EPICAST_DB_PASSWORD 'pass'
+ENV EPICAST_DB_NAME 'epicast2'
+
+COPY ./site/ /var/www/html/
+# ensure files are readable at runtime
+RUN chmod o+r -R /var/www/html

site/.htaccess

@@ -1,5 +1,14 @@
 RewriteEngine On
 
+## Restrict access to known users or docker development ##
+AuthType Basic
+AuthName "Restricted Site: Crowdcast"
+AuthBasicProvider file
+AuthUserFile /var/www/passwords
+Require user cctest
+Require ip 172.16.0.0/12
+## Restrict access to known users or docker development ##
+
 ## Compress Files ##
 <IfModule mod_deflate.c>
     <filesMatch "\.(js|css|html|php|svg|htm|xml|json)$">

site/FAQ.php

@@ -78,6 +78,52 @@
       another project (not crowdsourced) we are forecasting future
       demand on hospitals.
     </p>
+
+               </br>
+
+    <p>
+      <font size="5">
+	5. “Can you only see your score if you’re one of the top 10? / Can you see more than just last weeks forecast? I’m having trouble figuring out if my prior forecasts were any good. "
+      </font>
+    </p>
+    <p>
+      Answer: Unfortunately we can only show the top 10 scores.  However, your own score each week is always sent you you in the email you receive the following week.
+    </p>
+
+            </br>
+
+    <p>
+      <font size="5">
+	6. “I only have an iPhone. I do not have a computer to work on. Should I withdraw from the study or is there a way I can use my iPhone? "
+      </font>
+    </p>
+    <p>
+      Answer: Unfortunately we do not yet have a way to support smooth participation by phone.
+    </p>
+
+            </br>
+
+    <p>
+      <font size="5">
+	7. “On forecasting methodologies: Would you like us to forecast the following week, two weeks out, or the rest of the dates on the graph? Do you want us to use a method we can communicate to others? Do you want us to use a statistical method or just look at the data in the context of what you know from public information?"
+      </font>
+    </p>
+    <p>
+      Answer: Please forecast the rest of the time period shown on the Crowdcast display.  You may use any method you wish, including qualitative reasoning and personal judgement, using whatever data you have and anything else that you believe is relevant.  Your goal is to be as accurate as possible, regardless of the method you use.
+    </p>
+
+            </br>
+
+    <p>
+      <font size="5">
+	8. “On forecasting assumptions: Now that there is a pandemic, people are being asked to self-isolate if they have symptoms, instead of seeing a doctor, because of shortage of testing. Would you have to take that into consideration when making your forecasts? (i.e. it would be lower then you may predict because of lack of doctor’s visits, and lack of testing). Is it based on what I see around my area? People sheltering or using social distancing base not doing those things?"
+      </font>
+    </p>
+    <p>
+      Answer: You should take into account all considerations that you believe are relevant to what will eventually be measured and reported in the location for which you are forecasting.
+    </p>
+
+
   </div>
 </div>
 <?php