https://github.com/mwarman/serverless-framework-playground

A playground project for application components built atop The Serverless Framework.
https://github.com/mwarman/serverless-framework-playground

Last synced: about 2 months ago
JSON representation

A playground project for application components built atop The Serverless Framework.

• Host: GitHub
• URL: https://github.com/mwarman/serverless-framework-playground
• Owner: mwarman
• License: mit
• Created: 2024-03-25T12:41:55.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-05-03T10:38:43.000Z (8 months ago)
• Last Synced: 2024-05-03T14:51:22.969Z (8 months ago)
• Language: TypeScript
• Size: 232 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Serverless Playground - AWS Node.js Typescript

This project has been generated using the `aws-nodejs-typescript` template from the [Serverless framework](https://www.serverless.com/) and then modified slightly to use `serverless.yml` and standardize the project directory structures.

For detailed instructions, please refer to the [documentation](https://www.serverless.com/framework/docs/providers/aws/).

## Installation/deployment instructions

Depending on your preferred package manager, follow the instructions below to deploy your project.

> **Requirements**: NodeJS `lts/iron (v.20.11.1)`. If you're using [nvm](https://github.com/nvm-sh/nvm), run `nvm use` to ensure you're using the same Node version in local and in your lambda's runtime.

### Using NPM

- Run `npm i` to install the project dependencies

- Run `npx sls deploy` to deploy this stack to AWS

## Test your service

This template contains a single lambda function triggered by an HTTP request made on the provisioned API Gateway REST API `/ping` route with `GET` method.

### Remotely

Copy and replace your `url` - found in Serverless `deploy` command output - and `name` parameter in the following `curl` command in your terminal or in Postman to test your newly deployed application.

```

curl 'https://myApiEndpoint/dev/ping' \

```