neutrino-dev/packages/neutrino-middleware-start-server

Neutrino Start Server Middleware

neutrino-middleware-start-server is Neutrino middleware for starting a Node.js server for a file upon completion of a build.

Requirements

• Node.js v6.9+
• Yarn or npm client
• Neutrino v5

Installation

neutrino-middleware-start-server can be installed via the Yarn or npm clients.

Yarn

❯ yarn add neutrino-middleware-start-server

npm

❯ npm install --save neutrino-middleware-start-server

Usage

neutrino-middleware-start-server can be consumed from the Neutrino API, middleware, or presets. Require this package and plug it into Neutrino:

const server = require('neutrino-middleware-start-server');

// Use with default options, starting the server
// for the main entry point, neutrino.options.entry
neutrino.use(server);

// Usage with custom server file to start
neutrino.use(server, { name: 'custom.js' });

By default this middleware will start a server with the single entry point configured in Neutrino. This middleware optionally accepts an object with a name property for a path to a module which to start the server.

Customization

neutrino-middleware-start-server creates some conventions to make overriding the configuration easier once you are ready to make changes.

Plugins

The following is a list of plugins and their identifiers which can be overridden:

• start-server: Start a Node.js for a configured entry point or specified file.

Contributing

This preset is part of the neutrino-dev repository, a monorepo containing all resources for developing Neutrino and its core presets. Follow the contributing guide for details.