Data

Tools

Indexes

Applications

Experiments

Open Source Science

shieldpk12

Shield Playbook for K to 12

https://github.com/ncsa/shieldpk12

Science Score: 52.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ✓
    Institutional organization owner
    Organization ncsa has institutional domain (ncsa.illinois.edu)
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.3%) to scientific vocabulary
Last synced: 7 months ago · JSON representation ·

Repository

Shield Playbook for K to 12

Basic Info
  • Host: GitHub
  • Owner: ncsa
  • License: apache-2.0
  • Language: HTML
  • Default Branch: develop
  • Size: 6.45 MB
Statistics
  • Stars: 1
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 5 years ago · Last pushed over 2 years ago
Metadata Files
Readme License Citation

README.md

SHIELD K-12 Playbook

mainScreen.png visit https://shield-k12-playbook.ncsa.illinois.edu

How to Run

For local development

  • runsh exec.sh

For deployment

Deploy with domain name and SSL

  1. ssh into your remote machine
  2. Make suer you already install git, cron, docker:
    • Following the instruction of https://docs.docker.com/engine/install/ubuntu/ to install docker.
    • Install docker-compose following: https://docs.docker.com/compose/install/
  3. git clone this repository git clone https://github.com/ncsa/ShieldPK12.git
  4. Initialize SSL certificate by run sh init-letsencrypt.sh, please change the domain name to ones that you own. Right now this domain is pointing towards shield-k12-playbook.ncsa.illinois.edu. Check init-letsencrypt. sh for more details.
  5. To see if the whole stack comes together by running command docker-compose up
  6. To shut down the running app, run command docker-compose down
  7. Important note: you can run cronjob to automatically redploy if there is any change on the code repository. To do so, follows the below steps:
    • Change which git branch to monitor by modifying the BRANCH variable in redeploy.sh script.
      • E.g. point to the current branch: BRANCH=$(git branch --show-current)
      • E.g. point to the master branch BRANCH=master
    • Place */5 * * * * (cd /home/ubuntu/ShieldPK12 && sh redeploy.sh > redeploy.log) into a text file, e.g. job.txt
    • Then run command crontab job.txt. You can check if cronjob in place by crontab -l

Deploy without SSL

In case you do not own a domain name yet, or just want to deploy the test/develop version of the app, you can deploy without SSL: 1. Follow step 1 - 3 in previous section 2. Run command docker-compose -f docker-compose_wo_ssl.yml up --build -d. 3. Then you can access the web app at http://{hostIP}. See the custom docker compose file docker-composewossl.yml for more details.

Tutorials and Useful Links

How to develop a decision tree

How to add new modules

Code repository structure

Presentations and citations

Docker and docker compose explained

Module Class

Owner

  • Name: NCSA
  • Login: ncsa
  • Kind: organization
  • Location: Urbana, IL

National Center for Supercomputing Applications

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this application, please cite it as below."
authors:
- family-names: "Wang"
  given-names: "Chen"
  orcid: ""
- family-names: "Cheung"
  given-names: "Catherine"
  orcid: "https://orcid.org/0000-0002-9286-9576"
- family-names: "Chao"
  given-names: "Summer"
  orcid: ""
- family-names: "Gatzke"
  given-names: "Lisa"
  orcid: ""
- family-names: "Marini"
  given-names: "Luigi"
  orcid: "https://orcid.org/0000-0002-8511-0211"
- family-names: "Smith"
  given-names: "Rebecca"
  orcid: "https://orcid.org/0000-0002-8343-794X"
title: "Shield K-12 Playbook"
version: 1.0.0
date-released: 2021-08-18
url: "https://github.com/longshuicy/ShieldPK12"

GitHub Events

Total
Last Year

Dependencies

requirements.txt pypi
  • Flask ==1.1.1
  • gunicorn ==19.9.0
Dockerfile docker
  • python 3 build
docker-compose.yml docker
  • certbot/certbot latest
docker-compose_wo_ssl.yml docker
nginx/Dockerfile docker
  • nginx 1.17-alpine build
nginx_wo_ssl/Dockerfile docker
  • nginx 1.17-alpine build