https://github.com/palsp/halffin-adapter
chainlink external adapter use to feed shipment delivery status into ethereum blockchain
https://github.com/palsp/halffin-adapter
aws-dynamodb aws-lambda chainlink-adapter nodejs serverless-framework
Last synced: 23 days ago
JSON representation
chainlink external adapter use to feed shipment delivery status into ethereum blockchain
- Host: GitHub
- URL: https://github.com/palsp/halffin-adapter
- Owner: palsp
- Created: 2021-11-08T19:49:14.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2021-11-28T09:52:50.000Z (almost 4 years ago)
- Last Synced: 2025-02-23T01:34:20.346Z (7 months ago)
- Topics: aws-dynamodb, aws-lambda, chainlink-adapter, nodejs, serverless-framework
- Language: JavaScript
- Homepage:
- Size: 195 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Serverless Framework Node HTTP API on AWS
This template demonstrates how to make a simple HTTP API with Node.js running on AWS Lambda and API Gateway using the Serverless Framework.
This template does not include any kind of persistence (database). For more advanced examples, check out the [serverless/examples repository](https://github.com/serverless/examples/) which includes Typescript, Mongo, DynamoDB and other examples.
## Usage
### Deployment
```
$ serverless deploy
```
After deploying, you should see output similar to:
```bash
Serverless: Packaging service...
Serverless: Excluding development dependencies...
Serverless: Creating Stack...
Serverless: Checking Stack create progress...
........
Serverless: Stack create finished...
Serverless: Uploading CloudFormation file to S3...
Serverless: Uploading artifacts...
Serverless: Uploading service aws-node-http-api.zip file to S3 (711.23 KB)...
Serverless: Validating template...
Serverless: Updating Stack...
Serverless: Checking Stack update progress...
.................................
Serverless: Stack update finished...
Service Information
service: serverless-http-api
stage: dev
region: us-east-1
stack: serverless-http-api-dev
resources: 12
api keys:
None
endpoints:
ANY - https://xxxxxxx.execute-api.us-east-1.amazonaws.com/
functions:
api: serverless-http-api-dev-hello
layers:
None
```
_Note_: In current form, after deployment, your API is public and can be invoked by anyone. For production deployments, you might want to configure an authorizer. For details on how to do that, refer to [http event docs](https://www.serverless.com/framework/docs/providers/aws/events/apigateway/).
### Invocation
After successful deployment, you can call the created application via HTTP:
```bash
curl https://xxxxxxx.execute-api.us-east-1.amazonaws.com/
```
Which should result in response similar to the following (removed `input` content for brevity):
```json
{
"message": "Go Serverless v2.0! Your function executed successfully!",
"input": {
...
}
}
```
### Local development
You can invoke your function locally by using the following command:
```bash
serverless invoke local --function hello
```
Which should result in response similar to the following:
```
{
"statusCode": 200,
"body": "{\n \"message\": \"Go Serverless v2.0! Your function executed successfully!\",\n \"input\": \"\"\n}"
}
```
Alternatively, it is also possible to emulate API Gateway and Lambda locally by using `serverless-offline` plugin. In order to do that, execute the following command:
```bash
serverless plugin install -n serverless-offline
```
It will add the `serverless-offline` plugin to `devDependencies` in `package.json` file as well as will add it to `plugins` in `serverless.yml`.
After installation, you can start local emulation with:
```
serverless offline
```
To learn more about the capabilities of `serverless-offline`, please refer to its [GitHub repository](https://github.com/dherault/serverless-offline).