Git Product home page Git Product logo

serverless-analytics-api's Introduction

⚡⚡ Serverless Analytics API


architecture diagram

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

  1. Run npm run test to run the unit tests(Make sure to run the serverless offline application in background)

serverless-analytics-api's People

Contributors

azkarmoulana avatar

Stargazers

Roman avatar Ranmuni Imesha Udayanga De Zoysa avatar

Watchers

James Cloos avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.