Smart Greeter Flask Application

A personalized greeting web application built with Flask that provides time-based greetings and maintains greeting history. Perfect for learning Flask fundamentals and web development concepts.

🌟 Features

• 📝 Personalized Forms: Enter your name and profession
• ⏰ Time-Based Greetings: Dynamic greetings based on current time
• ✅ Input Validation: Client and server-side validation with error handling
• 📊 History Tracking: View all past greetings in a table
• 🔌 JSON API: RESTful endpoint for programmatic access
• 📱 Responsive Design: Mobile-friendly interface
• 🎨 Modern UI: Clean design with rounded corners and shadows

🚀 Quick Start

Prerequisites

• Python 3.7 or higher
• pip (Python package installer)

Installation

1. Clone the repository

   git clone https://github.com/enoughsudhanshu/smart-greeter-flask.git
   cd smart-greeter-flask

2. Create virtual environment

   python -m venv venv
   
   # Activate virtual environment
   # Windows:
   venv\\Scripts\\activate
   # macOS/Linux:
   source venv/bin/activate

3. Install dependencies

   pip install -r requirements.txt

4. Run the application

   python app.py

5. Open your browser Navigate to http://localhost:5000

📁 Project Structure

smart_greeter/
├── app.py                 # Main Flask application
├── requirements.txt       # Python dependencies
├── LICENSE               # MIT License
├── README.md            # Project documentation
├── .gitignore           # Git ignore rules
├── static/
│   └── style.css        # CSS styling
└── templates/
    ├── base.html        # Base template
    ├── index.html       # Home page
    ├── greeting.html    # Greeting display
    └── history.html     # History page

🔧 API Endpoints

Endpoint	Method	Description
/	GET	Home page with greeting form
/greet	POST	Process form and display greeting
/history	GET	View all greeting history
/api/greetings	GET	JSON API returning all greetings

API Response Example

[
  {
    "timestamp": "2025-09-12 15:30:00",
    "name": "John Doe",
    "work": "Software Developer",
    "greeting_text": "Good Afternoon, John Doe! We know you work as a Software Developer."
  }
]

💡 Learning Objectives

This project demonstrates:

• Flask Fundamentals: Routing, templates, forms
• Web Development: HTML, CSS, responsive design
• Input Validation: Security best practices
• API Development: JSON endpoints
• Template Inheritance: DRY principle
• Time-Based Logic: Dynamic content generation

🎨 Screenshots

Home Page

Clean form interface with validation

Greeting Display

Personalized time-based greeting

History View

Table showing all past greetings

🧪 Testing

Manual Testing

1. Visit home page and test form validation
2. Submit valid data and verify greeting
3. Check history page for stored greetings
4. Test API endpoint at /api/greetings

Validation Rules

• Name and Work fields are required
• Length must be between 1-40 characters
• Input is sanitized (spaces trimmed)
• Error messages display inline

🔒 Security Features

• Input Sanitization: Prevents XSS attacks
• Form Validation: Server-side validation
• Template Escaping: Jinja2 auto-escaping
• Length Limits: Prevents overflow attacks

🌍 Time-Based Greetings

Time Range	Greeting
5:00 AM - 11:59 AM	Good Morning
12:00 PM - 4:59 PM	Good Afternoon
5:00 PM - 8:59 PM	Good Evening
9:00 PM - 4:59 AM	Good Night

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

See CONTRIBUTING.md for details.

📚 Educational Use

This project is perfect for:

• Computer Science Students: Learning web development
• Flask Beginners: Understanding framework basics
• College Projects: Meeting academic requirements
• Portfolio Projects: Demonstrating skills

🔧 Technologies Used

• Backend: Flask 2.3.3, Python 3.7+
• Frontend: HTML5, CSS3, Jinja2 Templates
• Development: Virtual Environment, Git
• Deployment: Can be deployed to Heroku, PythonAnywhere, etc.

📝 License

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

👨‍💻 Author

Sudhanshu Pandey

• GitHub: @enoughsudhanshu
• Email: sudhanshupandey10124@gmail.com

🙏 Acknowledgments

• Flask documentation and community
• Python Software Foundation
• Open source contributors

📞 Support

If you have any questions or run into issues:

1. Check the Issues page
2. Create a new issue if needed
3. Contact the author

🔮 Future Enhancements

• User authentication system
• Database integration (SQLite/PostgreSQL)
• Theme toggle (light/dark mode)
• Export greetings to CSV
• Email notifications
• Multiple language support
• Mobile app version

---

⭐ Star this repository if it helped you learn Flask!

Made with ❤️ for learning and education