@the-sett/serverless-elm-bridge

Use Elm with the serverless framework (deploy to AWS, Azure, Google)


License
MIT
Install
npm install @the-sett/serverless-elm-bridge@4.0.0

Documentation

serverless

Contacts for Support

elm-serverless

Deploy an Elm HTTP API to using the serverless framework. This can be used to write AWS Lambda functions in Elm. Other cloud serverless functions are supported too, through the serverless framework.

elm/http defines an API for making HTTP requests.

the-sett/elm-serverless defines an API for receiving HTTP requests, and responding to them.

It can be run standalone on your local machine, which is often used for development and testing purposes. It is usually deployed to the cloud using the serverless framework.

npm package - serverless-elm-bridge

Define your API in elm and then use the npm package to bridge the interface between the [serverless][] framework and your Elm program. The npm package is available here: https://www.npmjs.com/package/@the-sett/serverless-elm-bridge

This can be installed into your package.json like this:

"dependencies": {
  "@the-sett/serverless-elm-bridge": "^3.0.0",
  ...

The same version of the npm bridge package should be used as the Elm package.

Documentation

  • Example Code - Best place to start learning about the framework. Contains several small programs each demonstrating a separate feature. Each demo is supported by an end-to-end suite of tests.

    There are instructions there on how to get set up and deploy an Elm serverless application on AWS.

  • API Docs - Hosted on elm-lang packages, detailed per module and function documentation. Examples are doc-tested.