wbqd / serverless-ts-template

Serverless Typescript Template

🚧 Severless Typescript Template

Serverless + Typescript Template

An easy-to-use Serverless template!

• Allowed to use typescript in serverless.js!

📥 Installation

Template Download & Install

git clone https://github.com/hmmhmmhm/serverless-ts-template
cd serverless-ts-template
npm install

Install Serverless

npm install -g serverless

📜 Configulation

🚀 Create Hosting Service

• Create Lambda in AWS
  • (Recommended to read before the start)
    • What is the Lambda [ENG]
    • What is the Lambda [KOR]
  • https://docs.aws.amazon.com/lambda/latest/dg/lambda-nodejs.html

👩‍💻 Config Serverless

You must need to setup before deploy action using to serverless config command. and must correctly set the provider config in "serverless.yml"

• ENG Guide
• KOR Guide

📦 Config Template

• You must change the handler names in every files.
  • Open up "handler.ts" and "serverless.yml" files.
  • Fix "yourFunctionName" to actual Lambda Function names

📔 Command

• npm test (or npm start)

  Run the development local serveless server. This command creates a path accessible through HTTP.

• npm run deploy

  Deploy the file to the physical server. (like a AWS)

License

MIT Licensed.