https://github.com/azkarmoulana/serverless-analytics-api
:zap: :zap: Serverless Analytics API for real time dashboard
https://github.com/azkarmoulana/serverless-analytics-api
aws dynamodb lambda node serverless typescript
Last synced: 8 months ago
JSON representation
:zap: :zap: Serverless Analytics API for real time dashboard
- Host: GitHub
- URL: https://github.com/azkarmoulana/serverless-analytics-api
- Owner: azkarmoulana
- Created: 2021-06-04T17:29:04.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-06-04T17:58:43.000Z (almost 5 years ago)
- Last Synced: 2025-05-17T21:35:15.368Z (11 months ago)
- Topics: aws, dynamodb, lambda, node, serverless, typescript
- Language: TypeScript
- Homepage:
- Size: 135 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
:zap::zap: Serverless Analytics API
API to capture time series data from client application to genarate relevant metrics for real time dashboard
***
### How to run the app locally
1. Clone the repository
2. Navigate to the project folder
3. Run `npm install` to install all the required dependencies
4. Run `sls dynamodb install` to install DynamoDB local plugin(You need to have installed JRE(Java Runtime Environment) in your local machine)
5. Run `npm run start:dev` to start the serverless offline application locally
### API endpoints
**Request**
- Path: `/{STAGE}/metrics`
- Method: `POST`
- Required parameters:
- Need to add the required header values in request header
**Response**
- API returns the `201` on success
### Running unit tests
Unit tests are written using [Jest](https://jestjs.io/)
1. Run `npm run test` to run the unit tests(Make sure to run the serverless offline application in background)