Skip to content

rohithill/nithp

Repository files navigation

NITH Projects

A repo containing multiple projects relating to NIT Hamirpur.

Current list:

  • NITH Result Website
  • NITH Result API

Built using python3, flask, connexion, bootstrap. Virtual environment is managed using pipenv.

Getting Started

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

Please make sure that python version >= 3.8.

Open the terminal and run the following commands:

  1. Clone the repository
$ git clone https://github.com/rohithill/nithp.git
$ cd nithp
  1. Create the virtual environment and install dependencies
$ pipenv install
  1. Enter into shell
$ pipenv shell
  1. Run the application
$ flask run

Todo

  • Make a interface for simple users to view their result.
  • Implement a basic API to get results.
  • Implement pagination in the API.
  • Add sorting parameter in API
  • Add examples on how to use API in various cases.

Branches

master : All the changes are made in the master. All the pull requests are merged here finally.

deploy : This is the branch which is deployed to the website. Currently the deploy is automatic. All the push to this branch are deployed immediately.

Notes