Skip to content

readme.md

Latest commit

 

History

History
106 lines (77 loc) · 3.46 KB

readme.md

File metadata and controls

106 lines (77 loc) · 3.46 KB
Raw

📺 Release Time Converter

🔹 What is This?

A simple tool to check when a TV show's next episode airs, converted to your local time. No more guessing when your favourite show is coming out!

✅ Current Progress

✔️ Core functionality complete – every input gets an output, so users are never left guessing.
✔️ Minimalist yet presentable design – clean and easy to use.
✔️ Rate Limiting Implemented – Prevents excessive API requests to avoid key suspension.

🔮 Future Plans

🔹 Specific Error Messages

  • Distinguish between "No upcoming episodes" vs. "Show not found."

🔹 Show Identification Issues

  • Some shows have multiple versions (remakes, different years), causing incorrect results.
  • Example: Searching for Battlestar Galactica might return the wrong version.
  • Potential fix: Allow users to select from multiple search results (an image preview could help).

🔹 Auto Convert to Local Time

  • Detect the user’s time zone and convert the air time automatically.

🔹 Countdown Timer ⏳

  • Show a live countdown until the next episode airs.

🔹 Show Past Episodes 📺

  • Fetch and display previous episodes alongside the next air date.

🔹 Alternative Timezones 🌍

  • Allow users to check different time zones (US, UK, AU, etc.).

🔹 Streaming Platform Link 🔗

  • Display where the show is available (Netflix, Hulu, Apple TV+, etc.).

🔹 Episode Information & Summary 📝

  • Include details like episode synopsis, duration, and creators.

🔹 Save Searches for Quick Access 🔖

  • Store the last searched show in localStorage for convenience.

🔹 UI Improvements 🎨

  • Add icons, animations, and smooth UI transitions.

⚠️ Current Issues

❌ Lack of Show Year/Specific Identification

  • No option to select between multiple results (e.g., Battlestar Galactica 2004 vs 1978).
  • Users might get incorrect results.
    Example Issue

❌ Non-Specific Error Handling

  • Doesn't differentiate between "No new episodes" and "Show not found."

❌ Potential Rate Limit Hits

  • Spamming "Convert Time" could get the API key suspended.
  • Implemented rate limiting to prevent abuse (1-minute and 10-minute cooldowns).

⏳ Rate Limiting Details

To prevent excessive API calls, rate limiting is in place:

  • 24 hour limit: Too many requests in a 24 hour period will block further queries.
  • Users who exceed limits will see a message explaining the cooldown period.

🔗 APIs Used

This project fetches TV show data from the TVMaze API:

  • Endpoint for show information: 
    https://api.tvmaze.com/shows/INSERT_ID_HERE

📦 Dependencies

Ensure you have the following installed in package.json:

"dependencies": {
  "axios": "^1.7.9",
  "cors": "^2.8.5",
  "dotenv": "^16.4.7",
  "express": "^4.21.2",
  "express-rate-limit": "^7.5.0",
  "node-fetch": "^3.3.2"
}

Install dependencies using:

npm install

💡 Made with HTML, CSS, JavaScript and Node.js 🎬

Hosted on Render

Thank you for taking the time to have a look at my first coding project!