Miss any of our Open RFC calls?Watch the recordings here! »

trailpack-express4

1.0.0-beta-2 • Public • Published

trailpack-express4

📦 Express 4 Trailpack

This pack binds the routes compiled in trailpack-router to a Express4 Server.

Usage

Load in your trailpack config.

// config/main.js
module.exports = {
  // ...
  packs: [
    require('trailpack-core'),
    require('trailpack-router'),
    require('trailpack-express4')
  ]
}

Static assets

// config/main.js
module.exports = {
  // ...
  paths: {
    ...
    www: path.resolve(__dirname, '..', 'public')
    ...
  }
}

View Config

Choose a template engine.

// config/views.js
module.exports = {
  engine: 'jade'
}

Then simply write your views in a directory called 'views'!

Configuration

See config/web.js for a full example.

port

The port to listen on. 3000 by default. Can also be set via the PORT environment variable.

host

The hostname of the server.

cache

The number of seconds to cache flat files on disk being served by Express

ssl

SSL options (key, cert or pfx) to allow set https protocol

redirectToHttps

Automatically redirect HTTP request to HTTPS if ssl enabled

portHttp

The port to listen for http protocol if ssl enabled. If you don't want http and https, don't add this field.

middlewares

Object to add custom middleware functions to Express, don't forget to add them into middlewares.order or they will not be called

Contributing

We love contributions! In order to be able to review your code efficiently, please keep the following in mind:

  1. Pull Requests (PRs) must include new and/or updated tests, and all tests must pass.
  2. Use eslint! See the eslintConfig in package.json.
  3. Please reference the relevant issue in your Pull Request.

License

MIT

Install

npm i trailpack-express4

DownloadsWeekly Downloads

1

Version

1.0.0-beta-2

License

MIT

Last publish

Collaborators

  • avatar