README.md

Running Next.JS and React /inside/ of ActionHero

An ActionHero example like https://github.com/zeit/next.js/tree/master/examples/custom-server-express

This server will render dynamic next.js/react pages on some routes, and normal ActionHero API requests on others!. We also show how to use the ActionHero Client to chat via websockets in a react app.

This configuration works with both Next and ActionHero hot reloading of code!

To install:

(assuming you have node and NPM installed)

npm install

To Run:

npm start

To Test:

npm test

How does this work?

1. Create an initializer to load next.js and create a handler that can extract the normal node req and res from the connection

// initializers/next.js

const {Initializer, api} = require('actionhero')
const next = require('next')

module.exports = class NextInitializer extends Initializer {
  constructor () {
    super()
    this.name = 'next'
  }

  async initialize () {
    api.next = {
      render: async (connection) => {
        if (connection.type !== 'web') { throw new Error('Connections for NEXT apps must be of type "web"') }
        const req = connection.rawConnection.req
        const res = connection.rawConnection.res
        return api.next.handle(req, res)
      }
    }

    api.next.dev = (api.env === 'development')
    if (api.next.dev) { api.log('Running next in development mode...') }

    api.next.app = next({dev: api.next.dev})
    api.next.handle = api.next.app.getRequestHandler()
    await api.next.app.prepare()
  }

  async stop () {
    await api.next.app.close()
  }
}

2. Create an action which will run the above api.next.render(connection). Note that we will not be relying on ActionHero to respond to the client's request in this case, and leave that up to next (via: data.toRender = false)

// actions/next.js

const {Action, api} = require('actionhero')

module.exports = class CreateChatRoom extends Action {
  constructor () {
    super()
    this.name = 'render'
    this.description = 'I render the next.js react website'
  }

  async run (data) {
    data.toRender = false
    return api.next.render(data.connection)
  }
}

3. Tell ActionHero to use the api rather than the file server as the top-level route in api.config.servers.web.rootEndpointType = 'api'. This will allows "/" to listen to API requests. Also update api.config.general.paths.public = [ path.join(__dirname, '/../static') ]. In this configuration, the next 'static' renderer will take priority over the ActionHero 'public file' api. Note that any static assets (CSS, fonts, etc) will need to be in "./static" rather than "./public".

Note that this is where the websocket server, if you enable it, will place the ActionheroWebsocketClient libraray.

4. Configure a wild-card route at the lowest priority of your GET handler to catch all web requests that aren't caught by other actions:

// config/routes.js

exports['default'] = {
  routes: (api) => {
    return {
      get: [
        { path: '/status', action: 'status' },
        { path: '/time', action: 'time' },
        { path: '/showDocumentation', action: 'showDocumentation' },
        { path: '/createChatRoom', action: 'createChatRoom' },

        { path: '/', matchTrailingPathParts: true, action: 'render' }
      ]
    }
  }
}

TODO

• disable the next.js logger. It fights with the ActionHero logger.
• there is a bug in the next hot-reloaded which prevents the mocha test from exiting properly. For now, you will need to ensure that you build your project fully before testing. Put next build into your npm pretest lifecycle directive.