Skip to content

Latest commit

 

History

History
108 lines (66 loc) · 3.88 KB

README.md

File metadata and controls

108 lines (66 loc) · 3.88 KB
Raw

🎉 Countdown App

Welcome to the Countdown App! This web application was born out of my need to keep track of important dates, like exams and deadlines, in a visually appealing and easily accessible way. Instead of hardcoding the dates in my code, I wanted to create something that anyone could use. So, here we are!

You can check out the app live here.

🤔 Why I Created This App

As a student, keeping track of exam dates can be a bit stressful. I needed a simple, yet effective way to display countdowns to my exams on my MacBook screen using the Plash app. Plash allows you to set any webpage as your desktop background, and I thought, why not create a customizable countdown app that fits right in?

🎯 Purpose

The Countdown App is designed to help you stay on top of your important dates. Whether it's exams, project deadlines, or any other events, this app will display a countdown timer for each event. It's visually intuitive, easy to use, and customizable.

📹 Demo

Demo

🛠️ Features

  • Add Custom Countdowns: Create personalized countdowns with names and specific dates.
  • Visual Indicators:
    • Dates are highlighted in white for upcoming events.
    • They turn red when the event is less than 4 weeks away.
    • They pulse red when the event is less than 2 weeks away.
  • Shareable URLs: Generate a unique URL to share your countdowns with others or use it with Plash.

💡 How It Works

  1. Visit the App: Go to exct.vercel.app to start creating your countdowns.
  2. Add a Countdown: Enter a name and date for your event and click "Add Countdown".
  3. Visualize Your Countdown: Watch your countdown timer update in real-time. Visual cues will help you know when events are approaching.
  4. Generate a URL: Click the "Generate URL" button to create a shareable link to your countdowns.
  5. Use with Plash: Set the generated URL as your desktop background using the Plash app on macOS.

🚀 Installation

If you'd like to run this app locally or contribute to its development, follow these steps:

📋 Prerequisites

  • Node.js (version 12 or higher)
  • npm (version 6 or higher)

⚙️ Installation

  1. Clone the repository:

    git clone https://github.com/noluyorAbi/countdown-app.git
cd exam-countdown-app

  2. Install the dependencies:

    npm install

  3. Start the development server:

    npm run dev

  4. Open your browser and navigate to http://localhost:3000 to see the app in action.

📖 Usage

➕ Adding a Countdown

  1. Enter the name of the countdown in the "Countdown Name" input field.
  2. Select the date and time for the countdown.
  3. Click the "Add Countdown" button to add the countdown to the list.

❌ Deleting a Countdown

  1. Click the "Delete Countdown" button next to the countdown you want to remove.

🔗 Generating a Shareable URL

  1. Click the "Generate URL" button.
  2. Copy the generated URL and share it with others or use it with the Plash app.

🛠️ Technologies Used

🤝 Contributing

Contributions are welcome! Please fork the repository and create a pull request with your changes. Feel free to reach out if you have any questions or suggestions.

📜 License

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

🙏 Acknowledgements

  • Inspired by the need for a custom countdown tool to display on a MacBook screen using the Plash app.

📞 Contact

Created by noluyorAbi - feel free to reach out!