https://github.com/pshycodr/wbscte-result-api
This is a Fun project. Please don't sue me (°ー°〃)
https://github.com/pshycodr/wbscte-result-api
Last synced: 10 months ago
JSON representation
This is a Fun project. Please don't sue me (°ー°〃)
- Host: GitHub
- URL: https://github.com/pshycodr/wbscte-result-api
- Owner: pshycodr
- Created: 2025-03-04T16:46:38.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-04T17:31:51.000Z (over 1 year ago)
- Last Synced: 2025-03-04T17:41:53.494Z (over 1 year ago)
- Language: JavaScript
- Size: 0 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# WBSCTE Diploma Results API
This is a **simple API** to fetch results for **WBSCTE Diploma Students** from the official website. It scrapes the data and presents it in a structured JSON format.
> **Disclaimer:** This is just a **time-pass project**, built for fun and learning. I have **no idea if this is legal or not**, so **please don’t sue me**! 🥺🤕
#### What does it do?
- Accepts registration number via POST request.
Fetches student results from the WBSCTE official result portal.
- Returns a clean JSON with student details, - subject-wise grades, and GPA.
#### Who is this for?
- Strictly for WBSCTE Diploma Students.
- If you’re not a WBSCTE student — you’re just here for the code, aren't you? 😉
#### Usecases
- 🤔 I don't know. Who thinks about usecases for a time-pass project? 😂
---
## 💻 Installation & Deployment
#### Clone the repository
```bash
git clone https://github.com/pshycodr/WBSCTE-Result-API.git
```
#### Then `cd WBSCTE-Result-API` into the directory do a
```bash
# Install dependencies
npm install
```
#### Install Serverless Framework
```bash
npm install -g serverless
```
#### Then Export your AWS **"IAM"** credentials with
```bash
export AWS_ACCESS_KEY=
export AWS_SECRET_ACCESS_KEY=
```
#### Then Deploy the project to AWS lamda functions using
```bash
serverless deploy
# Your API endpoint will be shown in the terminal
```
#### To test this locally before deploying
add your registration number in `event.json` file and run the following command
```bash
serverless invoke local -f getResult --path event.json
```
### Test The api after deploy
**Send a POST request with this Body**
```bash
{
"reg_no" : "your reg. no.",
"ph_no" : "your phone number"
}
```
## 🛠 Tech Stack
- **Node.js** (Serverless Functions)
- **AWS Lambda** (Hosting)
- **Axios** (HTTP Requests)
- **Cheerio** (Web Scraping)
## ⚠️ Important Notes
- This **only works for WBSCTE Diploma students**.
- If the website changes its structure, this might break.
- Use this responsibly, I take **no responsibility** for how you use it! 😎
## 📜 License
No license, because I don’t even know if this should exist. 😂