🚀 Installation & Setup

Prerequisites

• Python 3.8 or higher
• PostgreSQL 12 or higher
• pip (Python package manager)

Step 1: Clone or Download Project

cd smart-task-manager

Step 2: Create Virtual Environment

# On Windows
python -m venv venv
venv\Scripts\activate

# On macOS/Linux
python3 -m venv venv
source venv/bin/activate

Step 3: Install Dependencies

pip install -r requirements.txt

Step 4: Setup PostgreSQL Database

For detailed PostgreSQL setup instructions, see POSTGRES_SETUP.md

Quick Setup (Windows):

1. Install PostgreSQL from postgresql.org
2. Create database:

psql -U postgres
CREATE DATABASE smart_task_manager;
\q

3. Configure .env file:

DATABASE_URL=postgresql+psycopg://postgres:YOUR_PASSWORD@localhost:5432/smart_task_manager

4. Replace YOUR_PASSWORD with your PostgreSQL password

Step 5: Initialize Database

Use the initialization script to create tables and add sample data:

# Create tables
python init_db.py

# Create tables + add sample data
python init_db.py --seed

Login with test credentials (if seed data was added):

• Username: testuser
• Password: password123

Step 6: Run the Application

python run_app.py

The application will start at http://localhost:5000

Available Commands:

• python run_app.py - Start the application
• python test_api.py - Run API tests (app must be running)
• python init_db.py --seed - Add sample data

📖 Usage Guide

1. Register a New Account

• Navigate to the registration page
• Enter username (minimum 3 characters)
• Enter valid email address
• Enter password (minimum 6 characters)
• Confirm password
• Click "Create Account"

2. Login

• Enter your username and password
• Click "Sign In"
• You'll be redirected to the dashboard

3. Create Tasks

• Fill in the task title (required)
• Add optional description
• Select priority (High, Medium, Low)
• Set due date (optional)
• Click "Create Task"
• Notification will confirm task creation
• Task appears immediately in the table

4. Manage Tasks

View Tasks:

• All your tasks appear in the table
• Filter by status or priority using the filter options
• Click "Refresh" to reload tasks

Edit Tasks:

• Click "Edit" button on any task row
• Modify task details in the modal
• Change priority and status
• Click "Update Task"

Delete Tasks:

• Click "Delete" button on any task row
• Confirm deletion
• Task is removed immediately

5. Monitor Analytics

• Dashboard displays real-time analytics cards
• Total Tasks: Count of all your tasks
• Completed: Number of finished tasks
• Pending: Tasks not started
• In Progress: Tasks being worked on
• Completion Rate: Percentage of completed tasks
• High Priority: Count of high-priority tasks

6. Real-time Notifications

• Notifications appear in the top-right corner
• Automatic dismissal after 5 seconds
• Success/error/info messages for all actions

🔌 REST API Endpoints

Authentication Routes

POST   /auth/register       - User registration
POST   /auth/login          - User login
GET    /auth/logout         - User logout
GET    /auth/profile        - View user profile

Task API Routes

GET    /api/tasks           - Get all tasks (with optional filters)
GET    /api/tasks/<id>      - Get single task
POST   /api/tasks           - Create new task
PUT    /api/tasks/<id>      - Update task
DELETE /api/tasks/<id>      - Delete task
GET    /api/tasks/stats     - Get task statistics

Query Parameters (GET /api/tasks)

• status: Filter by status (pending, in_progress, completed)
• priority: Filter by priority (low, medium, high)
• sort_by: Sort by field (created_date, due_date, priority)

Example API Requests

Get All Tasks:

curl -X GET http://localhost:5000/api/tasks \
  -H "Content-Type: application/json"

Create Task:

curl -X POST http://localhost:5000/api/tasks \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Buy groceries",
    "description": "Milk, eggs, bread",
    "priority": "high",
    "due_date": "2026-05-15"
  }'

Update Task:

curl -X PUT http://localhost:5000/api/tasks/1 \
  -H "Content-Type: application/json" \
  -d '{
    "status": "completed",
    "priority": "medium"
  }'

Get Analytics:

curl -X GET http://localhost:5000/api/tasks/stats \
  -H "Content-Type: application/json"

⚙️ Configuration

Edit config.py to customize:

# Secret key for sessions
SECRET_KEY = 'your-secret-key-here'

# Database connection
SQLALCHEMY_DATABASE_URI = 'postgresql://user:password@localhost:5432/db_name'

# Session settings
PERMANENT_SESSION_LIFETIME = timedelta(days=7)

# WebSocket settings
SOCKETIO_ASYNC_MODE = 'threading'

🔐 Security Features

• Password Hashing: Bcrypt with 12 rounds for secure password storage
• Session Management: Secure Flask session handling
• Login Protection: Routes require authentication
• Input Validation: Form validation on both client and server
• SQL Injection Prevention: SQLAlchemy ORM protection
• CSRF Protection: Flask session-based protection

📊 Analytics Engine

The analytics module uses Pandas and NumPy to calculate:

• Task Statistics: Count tasks by status
• Completion Rate: Percentage of completed tasks
• Priority Distribution: Tasks by priority level
• Average Completion Time: Using datetime calculations
• Trend Analysis: Historical task data

🌐 WebSocket Events

Server-side Events:

• task_created: Emitted when a new task is created
• task_updated: Emitted when a task is updated
• task_deleted: Emitted when a task is deleted

Client-side Events:

• connect: Triggered when client connects
• disconnect: Triggered when client disconnects

🐛 Troubleshooting

Database Connection Error

Problem: psycopg2.OperationalError: could not connect to server

Solution:

1. Ensure PostgreSQL is running
2. Check database credentials in config.py
3. Verify database exists: CREATE DATABASE smart_task_manager;

Port Already in Use

Problem: OSError: [Errno 48] Address already in use

Solution: Modify the port in app.py:

socketio.run(app, host='0.0.0.0', port=5001, debug=True)

Import Errors

Problem: ModuleNotFoundError: No module named 'flask'

Solution: Reinstall dependencies:

pip install -r requirements.txt

WebSocket Connection Failed

Problem: WebSocket connection errors in browser console

Solution:

1. Ensure Flask-SocketIO is installed
2. Check browser console for errors
3. Verify CORS settings in config.py

📝 Environment Variables

Create a .env file for sensitive configuration:

SECRET_KEY=your-secret-key
DATABASE_URL=postgresql://user:password@localhost:5432/smart_task_manager
FLASK_ENV=development

Load in config.py:

from dotenv import load_dotenv
load_dotenv()

🚢 Deployment

For Production

1. Set Environment:

FLASK_ENV=production
DEBUG=False
SESSION_COOKIE_SECURE=True

2. Use Production Server (e.g., Gunicorn):

pip install gunicorn
gunicorn --worker-class eventlet -w 1 app:app

3. Configure HTTPS using reverse proxy (Nginx, Apache)

4. Database: Use hosted PostgreSQL service (AWS RDS, Heroku, etc.)

📚 Additional Resources

• Flask Documentation
• SQLAlchemy ORM
• Flask-SocketIO
• PostgreSQL Docs
• Pandas Documentation
• NumPy Documentation

📄 License

This project is provided as-is for educational and development purposes.

👥 Support

For issues or questions:

1. Check the troubleshooting section
2. Review Flask documentation
3. Check browser console for JavaScript errors
4. Review server logs for Python errors

✅ Checklist for First-time Setup

• Clone/download project
• Create virtual environment
• Install requirements.txt
• Create PostgreSQL database
• Update config.py with database credentials
• Run application
• Register new account
• Create test tasks
• Verify real-time updates
• Check analytics display

🎉 You're All Set!

Start managing your tasks efficiently with the Smart Task Management System!

Happy tasking! 📋✨