/iitkgp-erp-auto-login-extension

[Browser Extension] Minimial yet powerful and customizable autologin/autofill extension, for IIT Kharagpur enrolled students. :octocat:

Primary LanguageHTMLMozilla Public License 2.0MPL-2.0

ERP Auto Login - IITKGP logo

ERP Auto Login - IITKGP

Minimial yet powerful and customizable autologin/autofill extension, for IIT Kharagpur enrolled students.
Report a bug · Request feature · Feedback

Cover

ERP Auto Login - IITKGP

Our default branch master is the source code to the recent stable release. Want to test beta versions? Head to the develop branch to view the latest updates and features before the official release.

This extension never shares your credentials. It stays locally in your browser itself using the browser API storage.local by mozilla.

Table of contents

Status

Mozilla Add-on Mozilla Add-on Mozilla Add-on GitHub Mozilla Add-on Mozilla Add-on Code Style

Why Us?

  • Local only extension (serverless)
  • No fancy permissions, minimum permissions used to work.
  • Light on browser, size ~45-50 kilobytes
  • Updates every 2 months
  • Open source and documented code

Permissions Used

Installation

  • From Firefox/Chrome Stores (recommended)

    ERP Auto Login - IITKGP logo ERP Auto Login - IITKGP logo

    For android you can use extensions on the Nightly version of Firefox. follow this article to set it up.

  • From GitHub

    • Click here to download the latest release .xpi for firefox and .crx for chrome
    • Load the extension in Firefox as:
      1. Open Add-on Manager from options (or) by pressing Ctrl/Cmd+Shift+A on Widows/Mac
      2. Click the gear icon ⚙️ in the upper-right area of the Add-on Manager Extensions panel.
      3. Select Install Add-on from file... from the menu, then find and select the dowwloaded (.xpi) file.
    • Load the extension in Chrome as:
      1. Goto chrome://extensions/ in your chrome browser
      2. Enable developer mode by turning the switch on from the top right corner of the chrome browser
      3. Click on load unpacked and find and select the dowwloaded (.crx) file.
  • Build from source (for development)

    1. Clone the repository
      git clone https://github.com/siddsarkar/iitkgp-erp-auto-login-extension.git
    2. Cd into the repository
      cd iitkgp-erp-auto-login-extension
    3. Install dependencies
      yarn install
    4. Build the extension and watch for changes
      yarn dev:firefox # for firefox
      yarn dev:chrome # (or) for chrome
    5. The above step will create a chrome or a firefox folder with the extension in it.
    6. Run the extension using web-ext as below
      npm install --global web-ext # install web-ext globally (once only)
      web-ext run # run the extension for firefox
      web-ext run -t chromium # (or) run the extension for chrome
    7. Check that the extension is loaded by opening the extensions page in Firefox about:addons or in Chrome chrome://extensions/.

Bugs and feature requests

Have a bug or a feature request? Please first search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Previous releases

You can find all our previous releases on releases page of the github repo or directly from AMO Website

Todos

  • Add a reset warning
  • Add autofill mode
  • Show Changelogs on update
  • Add Overlay during autofill, show animation loader
  • Multiple users support
  • Add Uninstall, Install pages to show

Contributing

For Contributing to this project please open a pull request describing the changes or features with proper documentation.

Editor preferences are available in the editor config for easy use in common text editors. Read more and download plugins at https://editorconfig.org/.

Versioning

The Semantic Versioning guidelines is followed as far as versioning is concerned.

See the Releases section of our GitHub project for changelogs for each release version of this extension.

Thanks

Thanks to vs code and web-ext for providing the environment that allowed us to develop and test in real browsers!

Screenshots

Copyright and License

To the extent possible under law, Siddhartha Sarkar has waived all copyright and related or neighboring rights to ERP Auto Login - IITKGP. This work is published from: India.

CC0

Creator

Siddhartha Sarkar

Buy Me A Coffee