PLT Project

The NodeJs server to get Stock and Transaction Information.

Built With

The project has been built with NodeJs javascript runtime environment and ExpressJs NodeJs web application framework. To get a detailed knowledge, visit NodeJs and ExpressJs website.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

To be able to run the project on your local machine, you will need following development tools on your local machine.

1. NodeJs javascript runtime environment with version 12 and above.
2. yarn package manager.
3. Docker To run applications in dockerised container

Setup

Run node -v and yarn -v to check, whether your local machine has configured properly to run the project.

Local Deployment

To Run PLT Sample Project Locally

Clone main and cd into the project root directory

git clone [email protected]:ranjith-jagadeesh/plt.git
cd plt

Install all packages

yarn install

To build and run docker image

yarn docker-up

Once the project is up and running, use the below endpoint to verify

http://localhost:3000/?sku=SXV420098/71/68

To Run Tests

Jest and Supertest framework to test and verify requests

yarn test

Project Tech Stack

The application is built on following Tech Stack

Web Framework - Express

Test Framework - Jest, Supertest

Logging Requests - Morgan (Logging of all Express requests in a standardised format)