Skip to content

The KNIT-Result-API is a simple Node.js API developed by the Programming Club of KNIT to retrieve and cache student results based on their roll number.

Notifications You must be signed in to change notification settings

programming-club-knit/KNIT-Result-API

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

KNIT-Result-API

Introduction

The KNIT-Result-API is a simple Node.js API developed by the Programming and Tech Skills Club of KNIT to retrieve and cache student results based on their roll number.

  • It uses Redis for caching to improve response times. When a result is cached, it is served immediately; otherwise, there's a 1-second delay for fetching and storing the data in the cache.

Steps to Run

Clone Repo

git clone https://github.com/programmingclub-knit/KNIT-Result-API.git

Change directory

cd KNIT-Result-API

Install Dependencies

npm install

Set Docker Container For Redis

docker-compose up

Run Project

npm start


Usage

http://localhost:3000/cache?roll={roll_no_here}
There is 1 second delay when data is not cached

About

The KNIT-Result-API is a simple Node.js API developed by the Programming Club of KNIT to retrieve and cache student results based on their roll number.

Resources

Stars

Watchers

Forks

Languages

  • JavaScript 100.0%