README.md

Kontest Reminder

This is a cross-browser extension which will never let you forget about upcoming coding contests. To download from your respective web browser stores:

1. Chrome
2. Firefox

Authors

• Nisarg
• Anjali
• Rishikesh
• Akshay

Demo

Features

One click :

• Visit contest.
• Google Calendar Integration.
• Subscription.
• Reminder one 5-min before contest.

Developer quickstart

Install the required dependencies listed in package-lock.json using npm:

  npm clean-install

The reason why clean-install is preferred over install is explained here.

Running kontest-reminder with npm:

NOTE: Rename chrome-manifest / firefox-manifest as manifest depending on which browser you want to work with.

For development build

npm install -g web-ext
npm run start

Now, in another terminal tab:
cd dev
web-ext run (for firefox)
web-ext run -t chromium (for chrome)

The above method will allow live-reload of the extension for development.

If you don't want to install web-ext, you can perform the following steps:

  npm run start
  open chrome://extensions/ in chrome
  Toggle developer mode on
  Click load unpackaged
  select the newly created "dev" folder.

For production build

npm install -g web-ext
npm run build
cd build
web-ext run (for firefox)
web-ext run -t chromium (for chrome)

Again, the above method will allow live-reload of the extension for development.

If you don't want to install web-ext, you can perform the following steps:

Unpacking using chrome:

  npm run build
  Launch chrome and go to chrome://extensions/ (for chrome)
  Toggle developer mode on
  Click load unpackaged
  select newly created "build" folder.

Unpacking using firefox:

  npm run build
  cd build
  web-ext build (this will create a zip file)
  Launch firefox and go to about:debugging
  Click on "This Firefox", followed by "Load temporary add-on"
  Browse and select the zip file generated by web-ext.

You are good to go.

Support

For support, email [email protected] or [email protected].