Initial commit

.gitignore

@@ -0,0 +1,52 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules
+jspm_packages
+
+# Optional npm cache directory
+.npm
+
+# Optional REPL history
+.node_repl_history
+
+# vim
+.*.sw*
+Session.vim
+
+# Serverless
+.webpack
+.serverless
+
+# env
+env.yml
+.env
+
+# Jetbrains IDEs
+.idea

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Anomaly Innovations
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,135 @@
+# Serverless TypeScript Starter
+
+A Serverless starter that adds TypeScript, serverless-offline, linting, environment variables, and unit test support.
+
+This starter uses the [serverless-bundle](https://github.com/AnomalyInnovations/serverless-bundle) plugin and the [serverless-offline](https://github.com/dherault/serverless-offline) plugin. It supports:
+
+- **Generating optimized Lambda packages with Webpack**
+- **Using TypeScript in your handler functions and tests**
+- **Run API Gateway locally**
+  - Use `serverless offline start`
+- **Support for unit tests**
+  - Run `npm test` to run your tests
+- **Sourcemaps for proper error messages**
+  - Error message show the correct line numbers
+  - Works in production with CloudWatch
+- **Lint your code with ESLint**
+- **Add environment variables for your stages**
+- **No need to manage Webpack or Babel configs**
+
+---
+
+### Demo
+
+A demo version of this service is hosted on AWS - [`https://ylsml6v6r6.execute-api.us-east-1.amazonaws.com/dev/hello`](https://ylsml6v6r6.execute-api.us-east-1.amazonaws.com/dev/hello)
+
+And here is the ES6 source behind it
+
+``` javascript
+export async function hello(
+  event: APIGatewayEvent,
+  context: Context
+): Promise<APIGatewayProxyResult> {
+  return {
+    statusCode: 200,
+    body: JSON.stringify({
+      message: "Go Serverless v2.0! Your function executed successfully!",
+      context,
+      event,
+    }),
+  };
+}
+```
+
+### Requirements
+
+- [Install the Serverless Framework](https://serverless.com/framework/docs/providers/aws/guide/installation/)
+- [Configure your AWS CLI](https://serverless.com/framework/docs/providers/aws/guide/credentials/)
+
+### Installation
+
+To create a new Serverless project.
+
+``` bash
+$ serverless install --url https://github.com/AnomalyInnovations/serverless-typescript-starter --name my-project
+```
+
+Enter the new directory
+
+``` bash
+$ cd my-project
+```
+
+Install the Node.js packages
+
+``` bash
+$ npm install
+```
+
+### Usage
+
+To run a function on your local
+
+``` bash
+$ serverless invoke local --function hello
+```
+
+To simulate API Gateway locally using [serverless-offline](https://github.com/dherault/serverless-offline)
+
+``` bash
+$ serverless offline start
+```
+
+Deploy your project
+
+``` bash
+$ serverless deploy
+```
+
+Deploy a single function
+
+``` bash
+$ serverless deploy function --function hello
+```
+
+#### Running Tests
+
+Run your tests using
+
+``` bash
+$ npm test
+```
+
+We use Jest to run our tests. You can read more about setting up your tests [here](https://facebook.github.io/jest/docs/en/getting-started.html#content).
+
+#### Environment Variables
+
+To add environment variables to your project
+
+1. Rename `env.example` to `.env`.
+2. Add environment variables for your local stage to `.env`.
+3. Uncomment `environment:` block in the `serverless.yml` and reference the environment variable as `${env:MY_ENV_VAR}`. Where `MY_ENV_VAR` is added to your `.env` file.
+4. Make sure to not commit your `.env`.
+
+#### Linting
+
+We use [ESLint](https://eslint.org) to lint your code via [serverless-bundle](https://github.com/AnomalyInnovations/serverless-bundle).
+
+You can turn this off by adding the following to your `serverless.yml`.
+
+``` yaml
+custom:
+  bundle:
+    linting: false
+```
+
+To [override the default config](https://eslint.org/docs/user-guide/configuring), add a `.eslintrc.json` file. To ignore ESLint for specific files, add it to a `.eslintignore` file.
+
+### Support
+
+- Open a [new issue](https://github.com/AnomalyInnovations/serverless-typescript-starter/issues/new) if you've found a bug or have some suggestions.
+- Or submit a pull request!
+
+---
+
+This repo is maintained by [Anomaly Innovations](https://anoma.ly); makers of [Seed](https://seed.run) and [Serverless Stack](https://serverless-stack.com).

env.example

@@ -0,0 +1,8 @@
+# HOW TO USE:
+#
+# 1 Add environment variables for local development.
+# 2 Rename this file to .env and uncomment it's usage
+#   in the serverless.yml.
+# 3 Make sure to not commit this file.
+
+SAMPLE_ENV_VAR=i-am-an-environment-variable

handler.ts

@@ -0,0 +1,15 @@
+import { Context, APIGatewayEvent, APIGatewayProxyResult } from "aws-lambda";
+
+export async function hello(
+  event: APIGatewayEvent,
+  context: Context
+): Promise<APIGatewayProxyResult> {
+  return {
+    statusCode: 200,
+    body: JSON.stringify({
+      message: "Go Serverless v2.0! Your function executed successfully!",
+      context,
+      event,
+    }),
+  };
+}