The default express set up used for many projects.
- NodeJS >=10.0.0
- other requirements
This module, like many other
@bouncingpixel modules, relies on nconf.
The following configuration keys should be defined to use this module:
See additional information for:
- And any additional packages you may require in.
sessionSecretThe secret to use for securing session cookies.
PORTThe port to start Express on.
siterootHostThe domain of the site, used in canonical URLs and emails sent out, but can be used in other places with redirects.
forceDomainSet to true if the site should redirect to force the
domainlisted. Defaults to
requireHTTPSSet to true if the site should use HTTPS in all URLs (such as canonical). Defaults to
httpsRedirectSet to true if the site should redirect to HTTPS. You might want false and let CloudFlare do it. Defaults to
gatrackeridThe tracker ID for Google Analytics. When set, the GA code will be added to the page.
facebookpixelcodeThe tracker ID for Facebook Pixel. When set, the Facebook Pixel code will be added to the page.
WEBTOOLS_VERIF_IDCan be set to the ID needed by Webmaster Tools verification to create the .html page with the necessary content.
clientAn optional object and have other keys defined within it. These keys are exported to the
/js/config.jsas well as Dust under
webpackConfigPathThe path to the webpack config file if
routesPathThe path to the routes folder to automatically generate routes. Defaults to
viewPagesFolderThe name of the folder in the views directory to automatically generate routes. Defaults to
.init() without a parameter or with one parameter that contains the list of initializers. Initializers may be built-in module specified by the name, such as
error-router, or can be a function which takes one parameter, the Express app, and may return a Promise for async behavior.
const DefaultExpress = require('@bouncingpixel/default-express'); DefaultExpress.init( // you could optionally pass a different list of initializers here );
NOTE If you make use of
passport-auth, those package must be initialized before requiring in
Also See express-view-routing