nitd-results

REST API for accessing the results of NIT-Delhi students.

Explore the docs
Report a bug | Request a feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. License
5. Contact
6. Acknowledgments

About The Project

NIT Delhi publishes the semester wise results of students on this website. However, if one wishes to view the results of multiple students, then they will have to enter the student's details and captcha multiple times. Hence, I created this easy to use API that will fetch the results of multiple students at once. Students can be filtered on several factors - Branch, Batch and Program. Data is fetched from a remote Database which is populated once every semester using the populator.
This project is currently hosted on heroku and the API can be accessed here.

Built With

• Go
• Gorilla

Getting Started

This project is fairly simple to setup

Prerequisites

• Install Docker

Installation

1. Clone this repository using:

git clone https://github.com/killtheverse/nitd-results.git

A detailed guide can be found here.

2. Create a .env file and set environment variables:

PORT:<PORT>
MONGODB_USER:<MONGODB USER NAME>
MONGODB_PASSWORD:<MONGODB PASSWORD>
MONHODB_NAME:<DATABASE NAME>
MONGODB_URI:<MONGODB CONNECTION STRING>

3. Run:

docker-compose up

Usage

Following endpoints are available:

Endpoint	HTTP Method	CRUD Method	Function
students	GET	READ	Get all students
students/<roll_number>	GET	READ	Get details about a specific student
students/<roll_number>	PUT	UPDATE	Update information about a student

For more information, refer to the documentation here.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Rahul Dev Kureel - r.dev2000@gmail.com

Project Link: https://github.com/killtheverse/nitd-results

Acknowledgments

• Go web services
• MongoDB driver
• JWT Authentication
• Swagger
• Docker Compose
• Readme template