🏆 VictoryTimer

A kid-friendly quit-smoking timer web application that helps users track their progress in staying smoke-free.

📋 Features

• ⏱ Real-time Timer: Tracks time elapsed since your last cigarette
• 📈 Progress Visualization: Interactive chart showing your quit attempts history
• 💬 Motivational Messages: Time-based achievements and encouraging feedback
• 📱 PWA Support: Install as a mobile app on your device
• 🌙 Dark Theme: Kid-friendly dark mode design
• 💾 Local Storage: Your progress is saved locally in your browser

🚀 Quick Start

Prerequisites

• Python 3.7 or higher
• pip package manager

Installation

1. Clone the repository:

git clone https://github.com/yourusername/victorytimer.git
cd victorytimer

2. Create and activate a virtual environment:

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

3. Install dependencies:

pip install fastapi uvicorn

4. Run the application:

python main.py

5. Open your browser and navigate to http://localhost:8000

🖥️ Systemd Service Setup

The application can be run as a systemd service:

1. Create a service file at /etc/systemd/system/victorytimer.service:

[Unit]
Description=VictoryTimer Web App
After=network.target

[Service]
Type=simple
User=www-data
WorkingDirectory=/var/www/victorytimer
ExecStart=/var/www/victorytimer/venv/bin/python main.py
Restart=always

[Install]
WantedBy=multi-user.target

2. Enable and start the service:

sudo systemctl enable victorytimer
sudo systemctl start victorytimer

3. Check status:

sudo systemctl status victorytimer

📁 Project Structure

victorytimer/
├── main.py              # FastAPI backend server
├── static/              # Frontend assets
│   ├── index.html       # Main HTML page
│   ├── style.css        # Stylesheets with dark theme
│   ├── app.js           # Main application entry point
│   ├── timer.js         # Timer functionality
│   ├── button.js        # Button interactions
│   ├── chart.js         # Chart visualization
│   ├── message.js       # User messages and motivation
│   ├── service-worker.js # PWA service worker
│   ├── manifest.webmanifest # PWA manifest
│   └── favicon.ico      # Favicon
├── docs/                # Documentation
│   └── structure.md     # Detailed project structure
├── venv/                # Python virtual environment
├── .gitignore           # Git ignore rules
├── README.md            # This file
└── LICENSE              # MIT License

🎨 Dark Theme

The application features a kid-friendly dark theme with:

• Soft, easy-on-the-eyes colors
• High contrast for better readability
• Fun emoji icons and smooth animations
• Responsive design for all devices

🔧 Technologies Used

• Backend: Python 3.x, FastAPI
• Frontend: Vanilla JavaScript, HTML5, CSS3
• Charting: Chart.js for progress visualization
• PWA: Service Worker and Web App Manifest
• Icons: Emoji icons for universal compatibility

📊 How It Works

1. Start the timer when you quit smoking
2. The app tracks how long it's been since your last cigarette
3. View your progress in the timer and chart
4. Receive motivational messages as you reach milestones
5. If you slip up, reset the timer and keep trying!

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📝 License

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

🙏 Acknowledgments

• Built for anyone looking to quit smoking
• Kid-friendly design to help families support each other
• Open source for the community

---

Made with ❤️ for a smoke-free future