eureka-hello-api

Simple MicroService over Serverless Cloud with lemon-core. Nothing to manage at all, just run and go.

Description

• Sample boilerplate to develop the servlesss API based on Nodejs + Typescript
• Use DynamoDB as the main storage.

Usage

• Pre requirements (or installations) before starting.

  1. aws-cli with api-key
  2. git
  3. nodejs22
  4. (optional) httpie

• Fork(or clone), develop and deploy the serverless api.

  # clone the sample code.
  $ git clone https://github.com/lemoncloud-io/eureka-hello-api.git
  
  # STEP.1 install the dependecies.
  $ npm ci
  
  # STEP.2 run the server locally.
  $ npm run express
  
  # STEP.3 make request and develop locally.
  $ http :8000/hello
  
  # STEP.4 deploy into your AWS cloud (`AWS-Key` is required).
  $ npm run deploy
  
  # (example) use AWS authorized call.
  $ http --auth-type aws4 https://7s91yrozci.execute-api.ap-northeast-2.amazonaws.com/dev/hello/0 name=world
  
  # STEP.5 check the deploy info (`AWS-Key` is required).
  $ npm run info
  
  # STEP.6 remove(or uninstall) (`AWS-Key` is required).
  $ npm run remove

• Use AWS profile to deploy and manage the serverless api.

  # if you already configured AWS profile.
  $ aws configure --profile myprofile
  
  # STEP.1 deploy with specific AWS profile.
  $ AWS_PROFILE=myprofile npm run deploy
  
  # (example) use AWS authorized call.
  $ http --auth-type aws4 https://{your_deployed_api_id}.execute-api.ap-northeast-2.amazonaws.com/dev/hello/0 name=world
  
  # STEP.2 check the deploy info with specific AWS profile.
  $ AWS_PROFILE=myprofile npm run info
  
  # STEP.3 remove(or uninstall) with specific AWS profile.
  $ AWS_PROFILE=myprofile npm run remove

LICENSE

MIT

---

VERSION INFO

Version History

Version	Description
0.24.511	optimized with lemon-core#3.2.15.
0.24.1127	initial version with lemon-core#3.2.10.