WutIsMyMark - WIMM

A simple data scrapper from KCG Student login webpage

• WutIsMyMark - WIMM
• Installation
  • Requirements
  • Getting started
• Using WIMM
  • An NPM Package
  • Standalone
• Packages used
• License

Installation

Requirements

• Nodejs
• Yarn

Getting started

Clone this repository into your computer

git clone git@github.com:smartclash/WutIsMyMark.git

Go into that directory and install packages using yarn

Note: This will take time as we will be installing chromeium browser in the background

yarn

Now build the project

yarn build

The project has been built. You can now run it

node .

Using WIMM

An NPM Package

This project can be used as a standalone package. It's available at NPM and can be installed into any JS projects

yarn add wutismymark

...and then importing the library into your project

const wimm = require('wutismymark');
wimm.scrape('rollNumberHere', 'DOBHere', <semesterNumber>).then(data => {
    console.log(data);
}).catch(console.error);

Standalone

Go into src/App.ts and then into the bottom of the file. Change the rollnumber, password and the semester you want.

Build the project again and then run the project. Methods have been explained above already.

Packages used

• Puppeteer to scrap website
• Lodash to manage arrays and objects
• Table2Json to convert HTML table into JSON

License

MIT