Staging Environment: https://mn-staging.p-ebt.org/
bundle
yarn install
rake db:setup
- Run tests with
rake
. rails s
to run the server.
brew install k6
k6 run -e ENVIRONMENT=<development|staging|demo|production> --vus <number of virtual users> --iterations <number of iterations> loadtest.js
This Rails app has a few unique constructs:
- Because each screen asks only limited questions, validations on the ActiveRecord models can't be run on each save.
Therefore, we use a
Form
Model (which subclasses ActiveModel) to perform validations and param whitelisting. - A corresponding
FormsController
works in tandem with theForm
model. - The
FormNavigation
holds the logic for flow control: the order of the screens as well as the next screen.
Use Outside-In Test-Driven Development to implement a new screen:
- Start with the main Journey spec (
journey_spec.rb
). Add to the Journey spec and watch it fail. - Write a spec for and implement a new
FormsController
. Add the class name to theFormNavigation
. - Write a spec for and implement a new
Form
. - Implement any updates to the back-end models (
Household
andChild
) while updating corresponding unit specs. - Implement the screen as an ERB template (
edit.html.erb
). The Journey spec should now pass.
thor export:children FILE
: Export children (by default, only completely submitted children) to FILE (by default tmp/all.csv
). Run thor help export:children
for more options
RAILS_ENV
: Rails environment. Currently one ofdemo
,staging
,production
RAILS_MASTER_KEY
: For decrypting env vars loaded from credentials file.DATABASE_URL
: Postgres db connection string.SENTRY_DSN
: Sentry configuration.EXPERIMENT_OVER
: For use in early launch experiments. Setting to1
turns off/early
endpoint.SKYLIGHT_AUTHENTICATION
: Skylight configuration.DEMO_BANNER
: For use in non-prod environments. Setting to1
shows a demo banner.AUTH_USERNAME
: If set, the application will useAUTH_USERNAME
andAUTH_PASSWORD
via http authentication for each request.METRICS_USERNAME
/METRICS_PASSWORD
: Required to access/metrics
GOOGLE_PLACES_API_KEY
: API key for Google Places API for use in address autocomplete.AWS_REGION
: Required forthor export:upload_export_to_aws
AWS_EXPORT_UPLOAD_BUCKET
: Required forthor export:upload_export_to_aws
AWS_ACCESS_KEY_ID
: Required forthor export:upload_export_to_aws
AWS_SECRET_ACCESS_KEY
: Required forthor export:upload_export_to_aws