serverless-local-server-plus-static

Serverless Local Dev Server Plugin (Beta)

Develop Serverless endpoints with static files locally.

Supported features:

• Environment variables
• Basic HTTP integration
• Auto reload via nodemon (see How To)

This package requires node >= 6.0

How To

1. Install the plugin

npm install serverless-local-server-plus-static --save-dev

2. Add the plugin to your serverless configuration file

serverless.yml configuration example:

provider:
  name: aws
  runtime: nodejs6.10
 
functions:
  hello:
    handler: handler.hello
    events:
      - alexaSkill
      - http: GET /hello
 
# Add serverless-local-server-plus-static to your plugins: 
plugins:
  - serverless-local-server-plus-static
 
# if needed add folder for serving static files if necessary (relative to service path) 
custom:
  localDevStaticFolder: path/to/static/files

3. Start the server

serverless local-dev-server

On default the server listens on port 3000. You can specify another one with the --port argument:

serverless local-dev-server --port 5005

To automatically restart the server when files change, you may use nodemon:

nodemon --exec "serverless local-dev-server" -e "js yml json"

To see responses returned from Lambda and stack traces, prepend SLS_DEBUG=*

SLS_DEBUG=* serverless local-http-server

License & Credits

Licensed under the MIT license.

Forked from serverless-local-dev-server by DieProduktMacher.