metakgp / iitkgp-erp-auto-login

[Browser Extension] Auto Login Utility for students' ERP at IIT Kharagpur :octocat:
GNU Affero General Public License v3.0
3 stars 1 forks source link
[![Contributors][contributors-shield]][contributors-url] [![Forks][forks-shield]][forks-url] [![Stargazers][stars-shield]][stars-url] [![Issues][issues-shield]][issues-url] [![MIT License][license-shield]][license-url] [![Wiki][wiki-shield]][wiki-url]


image

ERP Auto Login - IIT KGP

ERP Auto Login - IIT KGP logo ERP Auto Login - IIT KGP logo

Minimial yet powerful and customizable autologin/autofill extension, for IIT KGP students
Request Feature / Report Bug

Table of Contents - [About The Project](#about-the-project) - [Building from source](#building-from-source) - [Prerequisites](#prerequisites) - [Development](#development) - [Deployment](#deployment) - [Usage](#usage) - [Contact](#contact) - [Maintainer(s)](#maintainers) - [Creators(s)](#creators) - [Additional documentation](#additional-documentation)

About The Project

image

ERP Auto Login is a browser extension supporting both chrome and firefox. The extension stores the users ERP credentials like username, password and security questions and fills them up automatically whenever the user opens the ERP. It also sends the OTP to the email, the user only need to fill up the OTP and continue to login.

(back to top)

Building from source

To set up a local instance of the application, follow the steps below.

Prerequisites

The following dependencies are required to be installed for the project to function properly:

(back to top)

Development

  1. Build the extension and watch for changes
     npm run start
  2. The above step will create a addon folder with the extension in it.
      cd addon
  3. Run the extension using web-ext as below, this starts a new browser window with the extension, this version supports hot reload
     web-ext run # run the extension for firefox
     web-ext run -t chromium # (or) run the extension for chrome

    (back to top)

Deployment

  1. Build the extension and watch for changes
     npm run build-prod

    The above step will create a addon folder with the extension in it.

  2. Adding to Browser:

    • For Chrome:

      • Open new tab and type chrome://extensions on search bar.
      • Toggle the DEVELOPER MODE on top right corner.
      • Click LOAD UNPACKED option, browse to the cloned folder and select the addon folder.
    • For Firefox:

      • Open new tab and type about:debugging#/runtime/this-firefox on search bar.
      • Click on the Load Temporary Add-on... button under Load Temporary Extensions Section.
      • Navigate to addon folder in your opened file navigator.
      • Select the manifest.json file inside it and press open.

(back to top)

Usage

Screenshots of the extension

(back to top)

Contact

📫 Metakgp - Metakgp's slack invite Metakgp's email metakgp's Facebook metakgp's LinkedIn metakgp's Twitter metakgp's Instagram

Maintainer(s)

The currently active maintainer(s) of this project.

Creator(s)

Honoring the original creator(s) and ideator(s) of this project.

(back to top)

Additional documentation

(back to top)