Skip to content

Utkarsh-username/exam-countdown-extension

 
 

Repository files navigation

Exam Countdown Extension

Exam Countdown Extension Logo

A browser extension that provides countdown timers for JEE and NEET exams, helping students track the time remaining until their important exams.

GitHub Release License Issues Pull Requests Homepage

📋 Table of Contents

✨ Features

  • Countdown Timers: Real-time countdown for JEE and NEET exams
  • 🎛️ Customizable Preferences: Show/hide countdowns based on your interests
  • 🖥️ Popup Interface: Quick access to countdowns via extension icon
  • 🆕 New Tab View: Detailed countdown view in a new tab
  • 🎨 User-Friendly Design: Clean and intuitive interface
  • 📅 Personalized Exams: Add and track your own exam dates
  • 🎵 Background Music: Play Spotify playlists or YouTube videos as background music

🚀 Installation

Stable Release

Download from GitHub Download from Chrome Web Store Download from Mozilla Add-ons

Beta Version

For Firefox:

  1. Download the .zip from Releases.
  2. Extract it to a folder.
  3. Open about:debugging#/runtime/this-firefox in Firefox.
  4. Click "Load Temporary Add-on..." and select the manifest.json file from the extracted folder.

For Chrome:

  1. Download the .zip from Releases.
  2. Extract it to a folder.
  3. Open chrome://extensions/.
  4. Enable Developer Mode (top right in Chrome).
  5. Click "Load unpacked" and select the extracted folder.

📖 Usage

  • Click on the extension icon to open the popup and view the countdowns.
  • Access the options page to set your preferences for displaying countdowns.
  • Use the countdown page for a detailed view, which can be opened in a new tab.
  • Add your own exam dates in the settings to personalize your countdown experience.

🤝 Contributing

We welcome contributions from everyone! Please see our Contributing Guide for details on how to get started.

🛠️ Local Development

Prerequisites

Before beginning, install pnpm globally (if not already installed):

npm install -g pnpm

Install Dependencies

Install the required dependencies for the project:

pnpm install

Development

To develop for Firefox, set the TARGET_BROWSER environment variable before running the dev server:

export TARGET_BROWSER=firefox  # Linux/macOS
set TARGET_BROWSER=firefox     # Windows (Command Prompt)
$env:TARGET_BROWSER="firefox"  # Windows (PowerShell)

Then start the development server:

pnpm dev

This will launch Firefox with your extension loaded. The page will automatically reload whenever you make changes to your code.

Build for Production

This command builds your extension for production. It optimizes and bundles your extension, preparing it for deployment to the target browser's store.

pnpm build

Linting

After building, you can run the linter on the production files in the dist/ directory to check for issues:

pnpm lint dist/

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

Releases

No releases published

Packages

No packages published

Languages

  • HTML 54.6%
  • JavaScript 44.1%
  • Other 1.3%