⚠️ Notice: This repository currently acts as a proof-of-concept, not an MVP or a production-ready system. For further information on the project's status, please refer to History.
- Hari Keshav Rajesh (GitHub) (LinkedIn)
- Raghav Gupta (GitHub) (LinkedIn)
The NSS MIT-BLR Volunteer App project is divided into two repositories, the API (you are here) and the mobile application. The mobile application repository can be found at nss-mitblr/app
On 13th August, 2024, the team commenced work on an application for the volunteers of NSS MIT-BLR in order to centralize their event contribution and resource management. This application was created with the aim to streamline administrative workflows and reduce the time spent in shift and volunteer hour calculation.
The project was archived on 20th February, 2025 after an elongated period of inactivity from the Core Committee, and inability to provide the hosting resources for the API that accompanies the application.
While we were unable to implement this project successfully, this repository remains public to provide other such endeavours with a headstart.
All core config values of the API exist as enviroment variables, a sample ENV file can be found at .env-example.
-
Install the dependency manager:
pip install poetry
-
Install the dependencies:
poetry install
-
Configure the environment variables:
cp .env-example .env
-
Generate an RSA keypair:
openssl genrsa -out private.pem 2048 openssl rsa -in private.pem -pubout -out public.pem
-
Run the development server:
poetry run task server
The project is now ready for development!