Add Codespaces support

This commit adds support for GitHub Codespaces. It includes a
devcontainer configuration that will be used to create a Codespace for
this repository. The configuration includes:

- Dockerfile: Installs `ruby:dev-3.2-buster` image. When the version of
  ruby used by this project changes, the Dockerfile should be
  updated. An attempt to install the correct version of ruby will be
  done, but it will take a while to download and compile the version.
- devcontainer.json: Specifies the configuration for the Codespace. It
  includes the Dockerfile to use, the extensions to install, and the
  settings to use.
- docker-compose.yml: Specifies the services to run in the Codespace. It
  includes the `postgres` service.
- post-create.sh: Script that runs after the Codespace is created. It
  optionally installs a new version of ruby, sets up the database, and
  prepares the environment.

Author: aeisenberg

.devcontainer/.env.codespaces

@@ -0,0 +1,14 @@
+# This is the .env that is used by the codespaces environment.
+# See the .devcontainer/devcontainer.json file for how this is configured.
+PG_USERNAME=postgres
+PG_PASSWORD=postgres
+DELAYED_JOB_USERNAME='admin'
+DELAYED_JOB_PASSWORD='password'
+FLIPPER_USERNAME="admin"
+FLIPPER_PASSWORD="password"
+RECAPTCHA_SITE_KEY=6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI
+RECAPTCHA_PRIVATE_KEY=6LeIxAcTAAAAAGG-vFI1TnRWxMZNFuojJ4WifJWe
+
+# [OPTIONAL] - Used to fetch copies of production DB
+AZURE_STORAGE_ACCOUNT_NAME=
+AZURE_STORAGE_ACCESS_KEY=

.devcontainer/Dockerfile

@@ -0,0 +1,5 @@
+# Installs Ruby 3.2.2. When human-essentials moves to a newer version of ruby,
+# it will be more efficient to change the image.
+# See https://github.com/devcontainers/images/blob/main/src/ruby/history/
+FROM mcr.microsoft.com/devcontainers/ruby:dev-3.2-buster
+RUN apt -y update && apt install -y vim curl gpg postgresql postgresql-contrib

.devcontainer/devcontainer.json

@@ -0,0 +1,20 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/postgres
+{
+  "dockerComposeFile": "docker-compose.yml",
+  "forwardPorts": [3000, 5432],
+  "workspaceFolder": "/workspaces/human-essentials",
+  "service": "app",
+  "customizations": {
+    "vscode": {
+      "extensions": ["Shopify.ruby-extensions-pack"],
+      "settings": {
+        "rubyLsp.rubyVersionManager": {
+          "identifier": "rvm"
+        }
+      }
+    }
+  },
+
+  "postCreateCommand": ".devcontainer/post-create.sh"
+ }

.devcontainer/docker-compose.yml

@@ -0,0 +1,32 @@
+version: '3.8'
+
+services:
+  app:
+    build:
+      context: ..
+      dockerfile: .devcontainer/Dockerfile
+
+    volumes:
+      - ../..:/workspaces:cached
+
+    # Overrides default command so things don't shut down after the process ends.
+    command: sleep infinity
+
+    # Runs app on the same network as the database container, allows "forwardPorts" in devcontainer.json function.
+    network_mode: service:postgres
+
+  postgres:
+    image: postgres:latest
+    restart: always
+    volumes:
+      - postgres-data:/var/lib/postgresql/data
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_DB: postgres
+      POSTGRES_PASSWORD: postgres
+    # Note that these ports are ignored by the devcontainer.
+    # Instead, the ports are specified in .devcontainer/devcontainer.json.
+    # ports:
+    #  - "5432:5432"
+volumes:
+  postgres-data:

.devcontainer/post-create.sh

@@ -0,0 +1,15 @@
+RUBY_VERSION="$(cat .ruby-version | tr -d '\n')"
+
+cp .devcontainer/.env.codespaces .env
+
+# source /usr/local/rvm/scripts/rvm
+
+# If the project's required ruby version changes from 3.2.2, this command
+# will download and compile the correct version, but it will take a long time.
+if [ "$RUBY_VERSION" != "3.2.2" ]; then
+  rvm install $RUBY_VERSION
+  rvm use $RUBY_VERSION
+  echo "Ruby $RUBY_VERSION installed"
+fi
+
+bin/setup

Gemfile.lock

@@ -752,4 +752,4 @@ DEPENDENCIES
   webmock (~> 3.23)
 
 BUNDLED WITH
-   2.5.7
+   2.5.9

README.md

@@ -65,7 +65,16 @@ Thanks for checking us out! If you're new here, here are some things you should
 ### Join us on slack 💬
 You can sign up [here](https://join.slack.com/t/rubyforgood/shared_invite/zt-21pyz2ab8-H6JgQfGGI0Ab6MfNOZRIQA) and find us in #human-essentials. Many helpful members are available to answer your questions. Just ask, and someone will be there to help you!
 
-##  Getting Started 🛠️
+##  Getting Started (Codespaces) 🛠️
+
+1. [Create a new Codespace.](https://docs.github.com/en/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository) It is recommended to open the Codespace in VS Code.
+2. Wait for the container to start. This may take a few minutes since Ruby 3.2.2 needs to be installed, the database needs to be created, and the `bin/setup` script needs to run.
+3. Run `bin/start` and visit http://localhost:3000/ to see the human essentials page.
+4. Login as a sample user with these default credentials (which also work for [staging](https://staging.humanessentials.app/)):
+
+Note that when the Ruby version in [`.ruby-version`](.ruby-version) changes, the image used by the Codespace should be updated too. See [`Dockerfile`](.devcontainer/Dockerfile) for more information.
+
+##  Getting Started (Local Environment) 🛠️
 
 1. Install Ruby
    - Install the version specified in [`.ruby-version`](.ruby-version).
@@ -411,4 +420,3 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
 This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
-