ceepredictor/cee-backend-api repository overview

⁠🧭 Overview

This Docker image provides the backend API for the Assam CEE College Predictor, a web service built using Express.js and Node.js. It delivers college prediction results based on candidate ranks, seat categories, and historical cutoff data.

The API is designed to integrate with a frontend application and can be deployed as a microservice or standalone server. It is containerized using Docker for easy setup, deployment, and scalability.

⁠🚀 Features

Key features:

• Rank-based predictions: Input an exam rank or marks and receive a ranked list of possible colleges and branches.
• Configurable data source: Plug in your own JSON/CSV or connect to a database (PostgreSQL, MongoDB, etc.) for cutoff and seat data.
• Lightweight & portable: Fully containerized for consistent behavior across development, staging, and production.
• CORS enabled: Ready to integrate with any web or mobile frontend.
• Environment-driven: Easily override ports, data paths, and service URLs via environment variables.

⁠🛠️ How to Run

Prerequisites:

• Docker installed on your machine

⁠Pull the image

docker pull ceepredictor/cee-backend-api

⁠Run the container

docker run -d -p 3000:3000 ceepredictor/cee-backend-api

⁠🧪 Test the API

Once the container is running, you can test the API using curl or any API client (like Postman or Insomnia).

⁠✅ Example Request

curl --location 'http://localhost:3000/api/v1/predict' \
--header 'Content-Type: application/json' \
--data '{
  "rank": 89,
  "marks": null,
  "category": "GENERAL",
  "govt_reservation": 0
}'

You can configure environment variables (like database URLs or secret keys) using the -e flag or a .env file depending on your setup.

⁠⚙️ Configuration