File path options

• appDir [String]: Root directory of your application. Default: The directory where your app's package.json is located.

• buildFolder [String]: Where build artifacts will be placed such as the output from preprocessed views, preprocessed statics, the views bundler feature, the controllers bundler feature, or the buildCache.json file used by the incrementalBuilds feature. Default: ".build".

  • You should .gitignore this folder.
  • Not all build artifacts will go into this folder. Some notable exceptions include:
    • .npm-cache: Generated by npm.
    • node_modules: Generated by npm.
    • package-lock.json: Generated by npm.
    • public: This is a separate folder for files generated by Roosevelt that should be exposed publicly as static files. The name of this folder is configurable with the publicFolder param.
    • secrets: Directory that stores certs, keys, and secrets. The name of this folder is configurable with the secretsPath param.

• controllersPath [String]: Relative path on filesystem to where your controller files are located. Default: "mvc/controllers".

• errorPages [Object]: Relative path on filesystem to where your various error page controller files are located. If you do not supply them, Roosevelt will use its default ones instead:

  • forbidden [String]: Your 403 Forbidden error page. Default: "403.js".
  • notFound [String]: Your 404 Not Found error page. Default: "404.js".
  • internalServerError [String]: Your 5xx Internal Server Error error page. Default: "5xx.js".
  • serviceUnavailable [String]: Your 503 Service Unavailable error page. Default: "503.js".

• modelsPath [String]: Relative path on filesystem to where your model files are located. Default: "mvc/models".

• preprocessedStaticsPath [String]: Relative path on filesystem to where your preprocessed static files will be written to. Preprocessed static files are static files that have been preprocessed by the minify-html-attributes module, if you have minifyHtmlAttributes enabled. This feature will only be active if minifyHtmlAttributes is enabled. Default: ".build/preprocessed_statics".

• preprocessedViewsPath [String]: Relative path on filesystem to where your preprocessed view files will be written to. Preprocessed view files are view files that have had their uses of web components progressively enhanced using the progressively-enhance-web-components module. To disable this feature, set the value to false. Default: ".build/preprocessed_views".

• publicFolder [String]: All files and folders in this directory will be exposed as static files in development mode or when hostPublic is enabled. You should .gitignore this folder. Default: "public".

• secretsPath [String]: Directory that stores certs, keys, and secrets. You should .gitignore this folder. Default: secrets.

• staticsRoot [String]: Relative path on filesystem to where your source static assets are located. By default this folder will not be made public, but is instead meant to store unprocessed or uncompressed source assets that will later be preprocessed and exposed in public. Default: "statics".

• viewsPath [String]: Relative path on filesystem to where your view files are located. Default: "mvc/views".