alanneves / serverless-boilerplate

A one template of web api node.js serverless with typescript, tests, continuous integration and delivery on GitHub Actions.

Serverless Boilerplate to API Node.js

This project has been created using the typescript, webpack, serverless-offline and more to make a great boilerplate from serverless apps Node.js.

Requirements: NodeJS lts/fermium (v.14.x). If you're using nvm, run nvm use to ensure you're using the same Node version in local and in your lambda's runtime.

Features

• ESLint and Prettier to check and maintain code quality
• Integration tests with Jest.
• GitHub Actions for run tests and collect coverage.
• GitHub Actions for deploy to AWS.

Using NPM

• Run npm i to install the project dependencies
• Run npx sls deploy to deploy this stack to AWS

Development enviroment

• Run serverless offline --httpPort 8001 to emulate.
• The application will start on http://localhost:8001/

3rd party libraries

• @serverless/typescript - provides up-to-date TypeScript definitions for your serverless.ts service file
• serverless-offline - plugin emulate AWS λ and API Gateway.