Task Scheduler

A simple, intuitive Task Scheduler - a cron-like job scheduler with GUI, notifications, and flexible scheduling options built for modern cross-platform usage.

🚀 Portfolio Project: Professional-grade task scheduler showcasing full-stack development skills with Python, JavaScript, and modern frameworks.

📸 Preview

Screenshots and demo GIFs will be added after first release

✨ Features

🎯 Core Functionality

Cross-platform: Works seamlessly on Windows, macOS, and Linux
Multiple Schedule Types: Cron expressions, intervals, one-time tasks, and startup tasks
Immediate Execution: Run any task instantly for testing and debugging
Task Management: Full CRUD operations (Create, Read, Update, Delete)
Execution History: Complete logging with stdout, stderr, and exit codes
Error Handling: Robust timeout management and error reporting

🖥️ User Interface

Modern GUI: Clean, responsive Electron-based desktop interface
Task Dashboard: Visual status indicators and real-time updates
Easy Task Creation: Intuitive forms with validation and helpful examples
Execution Monitoring: Detailed execution history with searchable logs
Theme Support: Light and dark mode support

🔧 Technical Features

RESTful API: Complete HTTP API for integration and automation
SQLite Database: Lightweight, file-based data persistence
System Notifications: Native OS notifications for task completion/failure
Configurable Timeouts: Per-task execution time limits
JSON Configuration: Easy import/export of task configurations

🚀 Quick Start

Prerequisites

Python 3.8+ - Backend API and task execution
Node.js 16+ - Frontend GUI and build tools
Git - Version control (for development)

Option 1: Quick Demo (Recommended)

# Clone and setup
git clone https://github.com/0x-Decrypt/task-scheduler.git
cd task-scheduler
chmod +x setup.sh demo.sh start.sh

# Install dependencies and run demo
./setup.sh
./start.sh &      # Starts backend in background
./demo.sh         # Interactive demo

Option 2: Manual Installation

# 1. Clone repository
git clone https://github.com/0x-Decrypt/task-scheduler.git
cd task-scheduler

# 2. Install dependencies
npm install
python3 -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
pip install -r backend/requirements.txt

# 3. Start backend API
python backend/simple_api.py &

# 4. Start frontend GUI
npm run dev

Option 3: Production Build

# Build executables for distribution
chmod +x build.sh
./build.sh

# Run the built application
cd dist/task-scheduler
./start.sh  # Linux/macOS
# or start.bat  # Windows

📋 Usage Examples

Creating Tasks via API

# Create a daily backup task
curl -X POST "http://localhost:8000/tasks" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Daily Backup",
    "description": "Backup important files",
    "command": "rsync -av ~/Documents ~/Backup/",
    "schedule_type": "cron",
    "schedule_config": {"expression": "0 2 * * *"},
    "timeout": 3600
  }'

# Create an interval-based system monitor
curl -X POST "http://localhost:8000/tasks" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "System Monitor",
    "command": "df -h && free -h",
    "schedule_type": "interval",
    "schedule_config": {"minutes": 15}
  }'

# Run a task immediately
curl -X POST "http://localhost:8000/tasks/{task-id}/run"

Schedule Types

Type	Description	Configuration Example
`cron`	Traditional cron expressions	`{"expression": "0 9 * * MON-FRI"}`
`interval`	Fixed time intervals	`{"hours": 2, "minutes": 30}`
`once`	Single execution at specific time	`{"run_date": "2025-12-31T23:59:59"}`
`startup`	Run when scheduler starts	`{}`

Common Cron Expressions

0 0 * * *          # Daily at midnight
0 9 * * MON-FRI    # Weekdays at 9 AM
0 0 1 * *          # First day of each month
0 */6 * * *        # Every 6 hours
*/15 * * * *       # Every 15 minutes

🏗️ Architecture

Project Structure

task-scheduler/
├── backend/                 # Python FastAPI backend
│   ├── simple_api.py       # Main API application
│   ├── models.py           # Data models and validation
│   ├── database.py         # Database configuration
│   └── requirements.txt    # Python dependencies
├── frontend/               # Electron desktop GUI
│   └── src/
│       ├── main.js         # Electron main process
│       ├── index.html      # Main application UI
│       ├── styles.css      # Application styling
│       └── app.js          # Frontend JavaScript logic
├── tests/                  # Test suites
│   └── test_api.py        # API integration tests
├── .github/               # GitHub workflows and templates
│   ├── workflows/         # CI/CD pipelines
│   └── ISSUE_TEMPLATE/    # Issue templates
├── scripts/               # Utility scripts
│   ├── setup.sh          # Environment setup
│   ├── start.sh          # Application launcher
│   ├── demo.sh           # Interactive demonstration
│   └── build.sh          # Production build
└── docs/                 # Documentation
    ├── README.md         # This file
    ├── CONTRIBUTING.md   # Contribution guidelines
    └── CHANGELOG.md      # Version history

API Endpoints

Method	Endpoint	Description
`GET`	`/health`	Health check
`GET`	`/tasks`	List all tasks
`POST`	`/tasks`	Create new task
`GET`	`/tasks/{id}`	Get specific task
`PUT`	`/tasks/{id}`	Update task
`DELETE`	`/tasks/{id}`	Delete task
`POST`	`/tasks/{id}/run`	Execute task immediately
`POST`	`/tasks/{id}/toggle`	Enable/disable task
`GET`	`/executions`	Get all execution history
`GET`	`/tasks/{id}/executions`	Get task-specific history

🧪 Testing

Run Tests

# Run all tests
python tests/test_api.py

# Run with coverage
pip install pytest pytest-cov
pytest tests/ --cov=backend --cov-report=html

# Integration testing
./demo.sh  # Interactive test of all features

Manual Testing

# Test backend API directly
curl http://localhost:8000/health
curl http://localhost:8000/tasks

# Test task execution
curl -X POST "http://localhost:8000/tasks" -H "Content-Type: application/json" \
  -d '{"name":"Test","command":"echo Hello","schedule_type":"once","schedule_config":{"run_date":"2025-12-31T23:59:59"}}'

🛠️ Development

Setting Up Development Environment

# Fork the repository on GitHub
git clone https://github.com/YOUR_USERNAME/task-scheduler.git
cd task-scheduler

# Create feature branch
git checkout -b feature/your-feature-name

# Install development dependencies
npm install
pip install -r backend/requirements.txt
pip install pytest pytest-cov flake8  # Development tools

# Run in development mode
python backend/simple_api.py &  # Backend with auto-reload
npm run dev                     # Frontend with DevTools

Code Style

Python: Follow PEP 8, use type hints, max 100 characters per line
JavaScript: ES6+, 2-space indentation, semicolons required
General: Meaningful names, functions ≤25 lines, comprehensive error handling

Contributing

Read CONTRIBUTING.md for detailed guidelines
Create feature branch from main
Write tests for new functionality
Ensure all tests pass
Submit pull request with clear description

📦 Building and Distribution

Create Production Build

./build.sh

This creates:

Standalone executables for each platform
Packaged application in dist/task-scheduler/
Compressed archive for distribution

System Requirements

Platform	Minimum	Recommended
Windows	Windows 10	Windows 11
macOS	macOS 10.14	macOS 12+
Linux	Ubuntu 18.04	Ubuntu 22.04+
Memory	512 MB RAM	1 GB RAM
Disk	100 MB free	500 MB free

🤝 Contributing

We welcome contributions! Whether you're fixing bugs, adding features, improving documentation, or reporting issues, your help makes this project better.

Ways to Contribute

🐛 Bug Reports: Found a bug? Create an issue
💡 Feature Requests: Have an idea? Suggest a feature
📝 Documentation: Help improve our docs
🧪 Testing: Help test new features and report issues
💻 Code: Submit pull requests with bug fixes or new features

See CONTRIBUTING.md for detailed guidelines.

📄 License

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

🙏 Acknowledgments

FastAPI for the excellent Python web framework
Electron for cross-platform desktop applications
SQLite for reliable embedded database
The open-source community for inspiration and feedback

📞 Support

📖 Documentation: Check the docs folder
🐛 Bug Reports: GitHub Issues
💬 Discussions: GitHub Discussions
✉️ Contact: Open an issue for questions or feedback

🏆 Author

0x-Decrypt

GitHub: @0x-Decrypt
Repository: task-scheduler

⭐ Star this repository if you find it useful! ⭐

Built with ❤️ for the open-source community

Name		Name	Last commit message	Last commit date
.github		.github
backend		backend
frontend/src		frontend/src
tests		tests
.gitignore		.gitignore
CHANGELOG.md		CHANGELOG.md
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
README.md		README.md
build.sh		build.sh
package.json		package.json
setup.sh		setup.sh
start.sh		start.sh

Latest commit

History

Folders and files

Repository files navigation

Task Scheduler

📸 Preview

✨ Features

🎯 Core Functionality

🖥️ User Interface

🔧 Technical Features

🚀 Quick Start

Prerequisites

Option 1: Quick Demo (Recommended)

Option 2: Manual Installation

Option 3: Production Build

📋 Usage Examples

Creating Tasks via API

Schedule Types

Common Cron Expressions

🏗️ Architecture

Project Structure

API Endpoints

🧪 Testing

Run Tests

Manual Testing

🛠️ Development

Setting Up Development Environment

Code Style

Contributing

📦 Building and Distribution

Create Production Build

System Requirements

🤝 Contributing

Ways to Contribute

📄 License

🙏 Acknowledgments

📞 Support

🏆 Author

About

Resources

Contributing

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages