[#208] Get Docker working and update README

.docker-config/Dockerfile

@@ -1,6 +1,6 @@
 FROM ruby:2.5.1
 
-RUN curl -sL https://deb.nodesource.com/setup_10.x | bash - && \
+RUN curl -sL https://deb.nodesource.com/setup_14.x | bash - && \
     curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add - && \
     echo "deb https://dl.yarnpkg.com/debian/ stable main" | tee /etc/apt/sources.list.d/yarn.list && \
     apt-get update && \
@@ -9,6 +9,9 @@ RUN curl -sL https://deb.nodesource.com/setup_10.x | bash - && \
     wget xvfb unzip && \
     rm -rf /var/lib/apt/lists/*
 
+ENV BUNDLER_VERSION='1.17.3'
+RUN gem install bundler:1.17.3
+
 RUN wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | \
     apt-key add - && \
     echo "deb http://dl.google.com/linux/chrome/deb/ stable main" >> \

.docker-config/wait-for-it.sh

@@ -0,0 +1,183 @@
+#!/usr/bin/env bash
+# Use this script to test if a given TCP host/port are available
+# (from https://github.com/vishnubob/wait-for-it)
+
+WAITFORIT_cmdname=${0##*/}
+
+echoerr() { if [[ $WAITFORIT_QUIET -ne 1 ]]; then echo "$@" 1>&2; fi }
+
+usage()
+{
+    cat << USAGE >&2
+Usage:
+    $WAITFORIT_cmdname host:port [-s] [-t timeout] [-- command args]
+    -h HOST | --host=HOST       Host or IP under test
+    -p PORT | --port=PORT       TCP port under test
+                                Alternatively, you specify the host and port as host:port
+    -s | --strict               Only execute subcommand if the test succeeds
+    -q | --quiet                Don't output any status messages
+    -t TIMEOUT | --timeout=TIMEOUT
+                                Timeout in seconds, zero for no timeout
+    -- COMMAND ARGS             Execute command with args after the test finishes
+USAGE
+    exit 1
+}
+
+wait_for()
+{
+    if [[ $WAITFORIT_TIMEOUT -gt 0 ]]; then
+        echoerr "$WAITFORIT_cmdname: waiting $WAITFORIT_TIMEOUT seconds for $WAITFORIT_HOST:$WAITFORIT_PORT"
+    else
+        echoerr "$WAITFORIT_cmdname: waiting for $WAITFORIT_HOST:$WAITFORIT_PORT without a timeout"
+    fi
+    WAITFORIT_start_ts=$(date +%s)
+    while :
+    do
+        if [[ $WAITFORIT_ISBUSY -eq 1 ]]; then
+            nc -z $WAITFORIT_HOST $WAITFORIT_PORT
+            WAITFORIT_result=$?
+        else
+            (echo > /dev/tcp/$WAITFORIT_HOST/$WAITFORIT_PORT) >/dev/null 2>&1
+            WAITFORIT_result=$?
+        fi
+        if [[ $WAITFORIT_result -eq 0 ]]; then
+            WAITFORIT_end_ts=$(date +%s)
+            echoerr "$WAITFORIT_cmdname: $WAITFORIT_HOST:$WAITFORIT_PORT is available after $((WAITFORIT_end_ts - WAITFORIT_start_ts)) seconds"
+            break
+        fi
+        sleep 1
+    done
+    return $WAITFORIT_result
+}
+
+wait_for_wrapper()
+{
+    # In order to support SIGINT during timeout: http://unix.stackexchange.com/a/57692
+    if [[ $WAITFORIT_QUIET -eq 1 ]]; then
+        timeout $WAITFORIT_BUSYTIMEFLAG $WAITFORIT_TIMEOUT $0 --quiet --child --host=$WAITFORIT_HOST --port=$WAITFORIT_PORT --timeout=$WAITFORIT_TIMEOUT &
+    else
+        timeout $WAITFORIT_BUSYTIMEFLAG $WAITFORIT_TIMEOUT $0 --child --host=$WAITFORIT_HOST --port=$WAITFORIT_PORT --timeout=$WAITFORIT_TIMEOUT &
+    fi
+    WAITFORIT_PID=$!
+    trap "kill -INT -$WAITFORIT_PID" INT
+    wait $WAITFORIT_PID
+    WAITFORIT_RESULT=$?
+    if [[ $WAITFORIT_RESULT -ne 0 ]]; then
+        echoerr "$WAITFORIT_cmdname: timeout occurred after waiting $WAITFORIT_TIMEOUT seconds for $WAITFORIT_HOST:$WAITFORIT_PORT"
+    fi
+    return $WAITFORIT_RESULT
+}
+
+# process arguments
+while [[ $# -gt 0 ]]
+do
+    case "$1" in
+        *:* )
+        WAITFORIT_hostport=(${1//:/ })
+        WAITFORIT_HOST=${WAITFORIT_hostport[0]}
+        WAITFORIT_PORT=${WAITFORIT_hostport[1]}
+        shift 1
+        ;;
+        --child)
+        WAITFORIT_CHILD=1
+        shift 1
+        ;;
+        -q | --quiet)
+        WAITFORIT_QUIET=1
+        shift 1
+        ;;
+        -s | --strict)
+        WAITFORIT_STRICT=1
+        shift 1
+        ;;
+        -h)
+        WAITFORIT_HOST="$2"
+        if [[ $WAITFORIT_HOST == "" ]]; then break; fi
+        shift 2
+        ;;
+        --host=*)
+        WAITFORIT_HOST="${1#*=}"
+        shift 1
+        ;;
+        -p)
+        WAITFORIT_PORT="$2"
+        if [[ $WAITFORIT_PORT == "" ]]; then break; fi
+        shift 2
+        ;;
+        --port=*)
+        WAITFORIT_PORT="${1#*=}"
+        shift 1
+        ;;
+        -t)
+        WAITFORIT_TIMEOUT="$2"
+        if [[ $WAITFORIT_TIMEOUT == "" ]]; then break; fi
+        shift 2
+        ;;
+        --timeout=*)
+        WAITFORIT_TIMEOUT="${1#*=}"
+        shift 1
+        ;;
+        --)
+        shift
+        WAITFORIT_CLI=("$@")
+        break
+        ;;
+        --help)
+        usage
+        ;;
+        *)
+        echoerr "Unknown argument: $1"
+        usage
+        ;;
+    esac
+done
+
+if [[ "$WAITFORIT_HOST" == "" || "$WAITFORIT_PORT" == "" ]]; then
+    echoerr "Error: you need to provide a host and port to test."
+    usage
+fi
+
+WAITFORIT_TIMEOUT=${WAITFORIT_TIMEOUT:-15}
+WAITFORIT_STRICT=${WAITFORIT_STRICT:-0}
+WAITFORIT_CHILD=${WAITFORIT_CHILD:-0}
+WAITFORIT_QUIET=${WAITFORIT_QUIET:-0}
+
+# Check to see if timeout is from busybox?
+WAITFORIT_TIMEOUT_PATH=$(type -p timeout)
+WAITFORIT_TIMEOUT_PATH=$(realpath $WAITFORIT_TIMEOUT_PATH 2>/dev/null || readlink -f $WAITFORIT_TIMEOUT_PATH)
+
+WAITFORIT_BUSYTIMEFLAG=""
+if [[ $WAITFORIT_TIMEOUT_PATH =~ "busybox" ]]; then
+    WAITFORIT_ISBUSY=1
+    # Check if busybox timeout uses -t flag
+    # (recent Alpine versions don't support -t anymore)
+    if timeout &>/dev/stdout | grep -q -e '-t '; then
+        WAITFORIT_BUSYTIMEFLAG="-t"
+    fi
+else
+    WAITFORIT_ISBUSY=0
+fi
+
+if [[ $WAITFORIT_CHILD -gt 0 ]]; then
+    wait_for
+    WAITFORIT_RESULT=$?
+    exit $WAITFORIT_RESULT
+else
+    if [[ $WAITFORIT_TIMEOUT -gt 0 ]]; then
+        wait_for_wrapper
+        WAITFORIT_RESULT=$?
+    else
+        wait_for
+        WAITFORIT_RESULT=$?
+    fi
+fi
+
+if [[ $WAITFORIT_CLI != "" ]]; then
+    if [[ $WAITFORIT_RESULT -ne 0 && $WAITFORIT_STRICT -eq 1 ]]; then
+        echoerr "$WAITFORIT_cmdname: strict mode, refusing to execute subprocess"
+        exit $WAITFORIT_RESULT
+    fi
+    exec "${WAITFORIT_CLI[@]}"
+else
+    exit $WAITFORIT_RESULT
+fi

.gitignore

@@ -25,6 +25,7 @@
 
 # Ignore master key for decrypting credentials and more.
 /config/master.key
+/config/database.yml
 /public/packs
 /public/packs-test
 /public/system

.tool-versions

@@ -1,3 +1,3 @@
 ruby 2.5.1
 nodejs 14.17.0
-yarn 1.22.10
+yarn 1.22.19

README.md

@@ -1,28 +1,115 @@
 # Storyboard
+An app for creating Choose Your Own Adventure stories
 
-## Setup
+## Local Development
 
-Copy key from https://viget.1password.com/vaults/all/allitems/546kllhiv5ehtdsn2rhvt4q56y into a file called `config/master.key`
+<details>
+  <summary>With Docker</summary>
 
-```
-asdf install
-gem install bundler -v 1.17.3
-bundle
-yarn install
-rake db:create db:migrate db:seed
-./bin/webpack-dev-server
-./bin/rails s
-```
+  ```bash
+  cp config/database.yml.example-docker config/database.yml
 
+  touch config/master.key
+  # This is a gitignored file which acts as the key to the encrypted/commited `config/credentials.yml` file.
+  # Copy/paste the password into the new config file:
+  # https://viget.1password.com/vaults/all/allitems/546kllhiv5ehtdsn2rhvt4q56y
+  ```
 
-# Docker
+  ### Build / Run
+  If you're building the docker containers for the first time, or if you know a dependency has been added (eg: ruby gem / node package), run this:
+  ```bash
+  docker compose build
+  ```
 
-```
-docker-compose build
-docker-compose up
-# May need to open a new tab in your terminal
-docker-compose exec app rake db:migrate
-docker-compose exec app rake db:seed
+  Once the containers have been built, starting the app is just:
+  ```bash
+  docker compose up
+
+  # And a shortcut for rebuilding containers while spinning them up at the same time:
+  docker compose up --build
+  ```
+
+  ### Seeding the database
+  ```bash
+  docker compose run --rm app bundle exec rake db:migrate
+  docker compose run --rm app bundle exec rake db:seed
+  ```
+
+  ### Running tests
+  ```bash
+  # Set up the test database
+  docker compose run --rm -e RAILS_ENV=test app rake db:create db:migrate
+
+  # Run specs
+  docker-compose run --rm app rspec
+  ```
+</details>
+
+<details>
+  <summary>Running Locally</summary>
+
+  ### Tooling and Dependencies
+  - If you have `asdf` installed, `.tool-versions` is set up for Ruby, Node, and Yarn versions.
+  - PostgreSQL
+    - version 11.x
+    - can be installed with homebrew
+
+
+  ### Configuration
+  ```bash
+  cp config/database.yml.example config/database.yml
+
+  touch config/master.key
+  # This is a gitignored file which acts as the key to the encrypted/commited `config/credentials.yml` file.
+  # Copy/paste the password into the new config file:
+  # https://viget.1password.com/vaults/all/allitems/546kllhiv5ehtdsn2rhvt4q56y
+  ```
+
+  ### Application Dependencies
+  If you don't have Bundler installed for Ruby:
+  ```bash
+  gem install bundler -v 1.17.3
+  ```
+
+  Install dependencies:
+  ```bash
+  # Install Ruby gems:
+  bundle install
+
+  # Install JS packages:
+  yarn install
+  ```
+
+  ### Set up database
+  ```bash
+  rake db:create db:migrate db:seed
+  ```
+
+  ### Run the application
+  ```bash
+  ./bin/rails s
+  ```
+
+  If you're updating CSS or JS, start webpacker to enable hot reloading:
+  ```bash
+  ./bin/webpack-dev-server
+  ```
+
+  Then open [http://localhost:3000](http://localhost:3000) with your favorite internet browser.
+
+  ### Run the test suite
+  ```bash
+  rspec
+  ```
+</details>
+
+## Deployment
+
+To deploy:
+
+```sh
+bundle exec cap production deploy
 ```
 
-**Note**: If you're building these images on Apple Silicon (M1/M2 Mac), you can use the environment variable `DOCKER_DEFAULT_PLATFORM=linux/amd64` to avoid platform-related build issues when running `docker-compose build`.
+## Contributing
+- We're using a "rebase and merge" workflow for a linear commit history.