README

Shim for Slim Skeleton to run on Google App Engine

Install

composer require groton-school/slim-gae-shim

Use

The shim expects a default slim-skeleton layout (and configures GAE to reflect this).

1. In your composer.json add a post-update-cmd update script:

{
  "scripts": {
    "post-update-cmd": "GrotonSchool\\Slim\\GAE\\Scripts::installGAEFiles"
  }
}

1. Run composer update

2. Add /node_modules/ to your .gitignore

3. Optionally, add *.bak to your .gitignore to suppress backed up prior versions of the GAE config files

4. Inject Google App Engine environment variables into settings:

   a. Implement SettingsInterface

   b. Define the SettingsInterface dependency

   c. Inject the remaining dependencies

   d. Inject the project URL and ID into your settings

5. Optionally (but recommendedly), suppress error log messages about Google App Engine start/stop requests by defining routes for those requests

6. Deploy to Google App Engine using the Node deploy wizard provided.

   a. Configure a Billing Account with your Google Cloud account, if not already done.

   b. Install the gcloud CLI

   c. Install Node dependencies with the package manager of your choice (e.g. pnpm install)

   d. Run the deploy wizard (pnpm run deploy) interactively (after the first run, this will set environment variables to allow it to be run non-interactively in the future)

groton-school/slim-skeleton@dev-gae/app

groton-school/slim-skeleton is the canonical example of how this shim is meant to be used.