Skip to content

Instantly share code, notes, and snippets.

@gregelin
Last active February 27, 2021 15:47
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save gregelin/090fbb542d905f7b8ec43eafb9af11d2 to your computer and use it in GitHub Desktop.
Save gregelin/090fbb542d905f7b8ec43eafb9af11d2 to your computer and use it in GitHub Desktop.

Installing GovReady-Q on Macintosh

Before you install

Your Mac will need to be running Python3 and some OS libraries for GovReady-Q's full features. Below are instructions for setting up your MacOS OS 10.14 or higher using Brew.

# install dependencies using brew
brew install python3

# install other packages:
brew install unzip graphviz pandoc selenium-server-standalone magic libmagic

# to generate thumbnails and PDFs for export, you must install wkhtmltopdf
# WARNING: wkhtmltopdf can expose you to security risks. For more information,
# search the web for "wkhtmltopdf Server-Side Request Forgery"
read -p "Are you sure (yes/no)? " ; if [ "$REPLY" = "yes" ]; then brew cask install wkhtmltopdf ; fi

Install GovReady-Q

# Clone GovReady-Q
git clone https://github.com/GovReady/govready-q govready-q-local
cd govready-q-local

# Create and activate virtual python3 environment
python3 -m venv venv
source venv/bin/activate

# Upgrade pip
pip install --upgrade pip

# Install GovReady-Q in non-interatictive mode
./install-govready-q.sh --non-interactive

If all goes well, terminal output will end as follows:

INFO: ALLOWED_HOSTS ['localhost']
WARNING: 'test_without_migrations' could not be imported
INFO: Connection scheme is 'http'.
INFO: 'SITE_ROOT_URL' set to http://localhost:8000 
WARNING: Specified PDF generator is not supported. Setting generator to 'off'.
WARNING: Specified IMG generator is not supported. Setting generator to 'off'.
System check identified some issues:

WARNINGS:
guidedmodules.AppVersion.system_app: (fields.W903) NullBooleanField is deprecated. Support for it (except in historical migrations) will be removed in Django 4.0.
Adding appname 'System-Description-Demo' from AppSource 'govready-q-files-startpack' to catalog.
2021-02-15 00:30:02,088 guidedmodules.app_loading level ERROR {"msg": "Failed to read README.md", "event": "read_from_readme.md"}
Adding appname 'PTA-Demo' from AppSource 'govready-q-files-startpack' to catalog.
Adding appname 'rules-of-behavior' from AppSource 'govready-q-files-startpack' to catalog.
Adding appname 'lightweight-ato' from AppSource 'govready-q-files-startpack' to catalog.
Adding AppSource for authoring.
Created administrator account (username: admin) with password: Tw8Eh8ZA8mY7wkCj22j68ADm
Created administrator portfolio admin
GovReady-Q configuration complete.
...

***********************************
* GovReady-Q Server configured... *
***********************************

To start GovReady-Q, run: 
  python3 manage.py runserver
or
  python manage.py runserver
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment