irving v1.0.1

Irving

Irving is a ReactJS based, isomorphically rendered, headless CMS frontend application.

Commands

• npm run build - Build the app for a production environment.
• npm run start - Start the built app.
• npm run dev - Run the app in development with change watches and isomorphic hot module reloading.
• npm run test - Run test suite.
• npm run test:watch - Rerun test suit when files change.

Setup

1. npm install

Development

After running npm run dev, navigate to http://localhost:3001 in your browser. Environment variable values can be modified by creating a .env file in the root of the project.

Environment

• ROOT_URL - The root url the app is served from. This value is required to prevent webpack assets from 404ing when the app isn't served from the root of a site.
• PORT - http port the server will serve from
• HOSTNAME - FQDN of the server host
• NODE_TLS_REJECT_UNAUTHORIZED - Only disable this when attempting to execute http requests to development APIs with self signed certificates. Never disable this in production.
• REDIS_URL - url of redis instance using redis:// protocol.
• CACHE_DURATION - time in seconds redis entries will persist before being automatically deleted, defaults to 5 minutes
• BASIC_AUTH_USERNAME
• BASIC_AUTH_PASSWORD
• DEBUG - https://github.com/visionmedia/debug#environment-variables
• NEW_RELIC_APP_NAME - Your New Relic license key.
• NEW_RELIC_LICENSE_KEY - The name of this application, for reporting to New Relic's servers. This value can be also be a comma-delimited list of names.
• PROXY_URL - URL to proxy all server requests through.
• HTTPS_KEY_PATH - Path to tls key relative to current home directory.
• HTTPS_CERT_PATH - Path to tls cert relative to current home directory.

Extra Query Params

Any environment variable that is prefixed with API_QUERY_PARAM_, for example API_QUERY_PARAM_MARKET=india, will be mapped to a query param with the prefix stripped out and the parameter name transformed to lowercase. This will allow you to add extra query parameters to all components requests.

Debug Namespaces

• render
  • error
  • request
• server
  • error
• components
• sagas
  • location

API Caching

Requests to the API host from the app running in Node can be cached with Redis. If the REDIS_URL is set, and the ioredis package is installed, caching will be enabled.

Basic Authentication

When both fields are set the express app will automatically apply the Authorization header for requests to the app. This will prompt the user to enter the valid credentials to access the site.

Application Monitoring

Transactions and errors can be logged to a monitoring service. Currently only newrelic is supported. To enabled newrelic the newrelic package must be installed, and the NEW_RELIC_APP_NAME and NEW_RELIC_LICENSE_KEY environment variable must be set. See here for additional newrelic configuration options.

HTTPS

In production HTTPS will typically be handled by the load balancer of the hosting environment. If you would like HTTPS for local development set the PROXY_URL, HTTP_KEY_PATH, and HTTPS_CERT_PATH environment variables.