Serverless Esbuild Template

This is a template repository to get you started really quickly with the serverless framework and typescript, using the incredible esbuild. It is slighlty opinionated.

TL:DR => How to use

# Make sure you have a modern node environment (example: node 14+, yarn)
# Make sure you have AWS credentials https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html

# Install dependencies
yarn

# Make sure everything works ™
yarn test

# Bundle your code and deploy it (This creates the needed AWS resources, Lambda, apiGw, s3...)
# Deploy will output the URL, refer to serverless documentation to see how everything gets mapped from the serverless.yml
# Everything is configurable, the default stage is dev, and default region is us-east-1
yarn deploy

# Example using curl to test your deployed lambda (make sure to use the correct url)
curl https://00000000.execute-api.us-east-1.amazonaws.com/dev/hello | jq

# Remove service (Removes everything created by sls deploy)
yarn remove

Features

⚡ serverless + esbuild = ❤

Built on top of the incredible esbuild, mad props to @evanw
Refer to serverless-esbuild for the plugin documentation, credits to @floydspace
Includes the amazing esbuild-register, thanks to @egoist

node -r esm -r esbuild-register script.ts #Aliased to TS for your convenience

Enjoy lighting fast build and script execution in typescript

⚙ Eslint / Prettier / Typescript / Yarn / dotenv

With sensible defaults because writing boilerplate takes too much time.

dotenv is intentionally a dev dependencies, if you want to use it at runtime, move it to dependencies, import it in your code then load your env file.

🧪 Tests with Jest, GitHub Actions, Dependabot

An example of an integration test that works with the great sls offline and the node-fetch package.

Simply run :

yarn test

A Github Action basic pipeline is setup with yarn caching and tests, check .github/workflows/main.yaml

📴 Serverless-offline dev/start/stop scripts with pm2

pm2 is a node process manager, very handy when you're dealing with several local microservices ...

{
    "offline:dev": "yarn ts scripts/offline.ts dev",
    "offline:start": "yarn ts scripts/offline.ts start",
    "offline:stop": "yarn ts scripts/offline.ts stop"
}

offline:dev : Start sls offline in the foreground.
offline:start : Start sls offline in the background with pm2, log the output to pm2.log
offline:stop : Terminate the pm2 process(es) cleanly (based on the name, check offline.ts)

Check offline.ts if you need custom behavior.

🌀 Serverless.ts

Use a serverless.ts files instead of a serverless.yml file for the configuration. You can delete the serverless.ts and rename serverless.example.yml to serverless.yml if you prefer yaml. Refer to the docs. More info in the PR.

View this repository on GitHub: https://github.com/Hebilicious/serverless-esbuild-template

nickgraffis/sls-playground