deepak-terse/stock-scan-parser-backend

A backend for Fitpage assignment build with fastify

Stock Scan Parser - Backend

This repository contains the backend code for the Stock Scan Parser web application, built using Fastify.

Description

The backend provides an API that returns the response data required by the frontend to display stock market scans. The response matches the output of the provided JSON data available at http://www.coding-assignment.bombayrunning.com/data.json.

Setup

1. Clone the repository

   https://github.com/deepak-terse/stock-scan-parser-backend.git

2. Install dependencies

   cd stock-scan-parser-backend
   npm install

3. Set environment variables

   Creat .env file in the root directory with following configuration or add them manually

   # Server configuration
   SERVER_HOST=localhost
   SERVER_PORT=3002

4. Start the development server

   npm run dev

To run the production build locally

npm run build
npm run start

To run the tests and check coverage

npm run test

Technologies used

• Fastify: A fast and low-overhead web framework for Node.js
• Jest: A delightful JavaScript testing framework with a focus on simplicity

Documentation

• API Documentation