๐ TaskMaster-API ๐
Interactive Task Management API
๐ฏ What is TaskMaster-API?
TaskMaster-API is an interactive web application that brings task management to life through real-time visualization. Built with modern web technologies, it provides an engaging platform for learning and understanding various task management operations.
๐ Key Features
- Interactive Visualizations: Watch task operations in action with real-time animations
- Multiple Operations: Explore 8 different task management operations
- Customizable Parameters: Adjust speed, task size, and more
- Performance Metrics: Track operations, updates, and time complexity
- Educational Insights: Learn about task management behavior and efficiency
- Responsive Design: Works seamlessly on desktop and mobile devices
"Visualize your tasks, understand management better!"
๐ Help Us Build Something Amazing Together!
Made task management click for you? You're exactly who we built this for! โจ
Help other developers discover what you just experienced ๐
๐ญ "Every star motivates us to add more features and operations!" - The TaskMaster-API Team
๐ Table of Contents
- โจ Features
- ๐ฆพ Tech Stack
- ๐ Project Structure
- ๐ธ Screenshots
- ๐ Quick Start
- ๐จโ๐ง Detailed Setup
- ๐ ๏ธ Developer Tools
- ๐ค Keploy AI API Testing
- ๐ฏ Target Audience
- ๐ค Contributing
- ๐ Awesome Contributors
- ๐ License
- ๐ฌ Feedback & Suggestions
โจ Features
๐ฎ Interactive Visualization
- Real-time visual representation of task management steps
- Adjustable animation speed
- Pause and resume functionality
- Task list size customization
- Random task generation
๐ Supported Operations
- Create Task: Simple task creation operation
- Read Tasks: In-place task retrieval
- Update Task: Adaptive task modification
- Delete Task: Efficient task removal
- Filter Tasks: Efficient, in-place filtering
- Sort Tasks: Comparison-based sorting using binary heap data structure
- Search Tasks: Non-comparative task searching
- Batch Operations: Distribution operations that group tasks into categories
๐ Performance Tracking
- Real-time operation count
- Update operation tracking
- Time complexity visualization
- API efficiency metrics
๐จ User Interface
- Modern, responsive design
- Dark mode support
- Mobile-friendly interface
- Intuitive controls
๐ค AI-Powered API Testing
- Keploy Integration: AI-powered API testing platform
- OpenAPI Schema: Complete API documentation
- Automated Testing: CI/CD pipeline with GitHub Actions
- Test Coverage: Comprehensive API endpoint validation
- Performance Monitoring: Real-time API testing and reporting
๐ฆพ Tech Stack
๐ Backend Technologies
- Runtime: Node.js
- Framework: Express.js
- Database: SQLite3
- Middleware: CORS, Body-parser, Helmet
- Security: Compression, Morgan logging
๐จ Frontend Technologies
- Styling: TailwindCSS with custom CSS
- JavaScript: Vanilla JS with modern ES6+
- UI: Glass morphism design with animations
- Responsive: Mobile-first responsive design
๐ ๏ธ Development Tools
- Package Manager: npm/pnpm
- Version Control: Git
- Testing: Custom API testing utilities
- Deployment: Vercel
๐ง Future Enhancements
- User authentication and authorization
- Real-time collaboration features
- Advanced task analytics
- Mobile app development
๐ Project Structure
TaskMaster-API/ # Main project repository
โโโ API_DOCUMENTATION.md # API documentation and endpoints
โโโ README.md # Project documentation (this file)
โโโ package.json # NPM package definition and scripts
โโโ pnpm-lock.yaml # PNPM package lock file
โโโ server.js # Main Express.js server file
โโโ test-api.js # API testing utilities
โโโ tasks.db # SQLite database file (auto-generated)
โโโ public/ # Static frontend assets
โโโ index.html # Main HTML frontend
โโโ styles.css # Custom CSS styles with Tailwind
โโโ script.js # Frontend JavaScript logic
๐ Key Directories and Files:
- server.js: Main Express.js server with SQLite database integration and RESTful API endpoints
- public/: Frontend assets including HTML, CSS, and JavaScript for the interactive task management interface
- public/index.html: Main frontend interface with modern glass morphism design and Tailwind CSS
- public/styles.css: Custom CSS with animations, responsive design, and beautiful UI components
- public/script.js: Frontend JavaScript with API integration, real-time updates, and interactive features
- API_DOCUMENTATION.md: Complete API reference with endpoints, request/response examples, and usage guides
- test-api.js: API testing utilities and example requests for development and debugging
- tasks.db: SQLite database file (auto-generated) for persistent task storage
๐ธ Screenshots
TaskMaster-API Interface
Screenshots coming soon! The application features:
- Modern Task Management Interface: Clean, intuitive design with glass morphism effects
- Real-time Task Operations: Create, read, update, and delete tasks with smooth animations
- API Testing Dashboard: Built-in interface for testing all API endpoints
- Responsive Design: Beautiful interface that works on desktop and mobile devices
- Performance Metrics: Real-time statistics and operation tracking
๐ท We're working on capturing the perfect screenshots to showcase the beautiful interface!
๐ค Keploy AI API Testing
๐ Overview
This project includes comprehensive AI-powered API testing using Keploy, integrated into our CI/CD pipeline for automated testing and validation.
๐ฏ API Testing Features
- โ
OpenAPI 3.0 Schema: Complete API documentation with request/response schemas
- โ
Automated Test Generation: AI-powered test case creation
- โ
CI/CD Integration: GitHub Actions pipeline with Keploy testing
- โ
Comprehensive Coverage: All API endpoints tested automatically
- โ
Performance Monitoring: Real-time API performance tracking
๐ Test Results Dashboard
๐ฏ Latest Keploy Test Execution Results

Test Suite Summary:
- โ
Total Test Suites: 20
- โ
Passed: 20 (100% success rate! ๐)
- โ Failed: 0 (Perfect execution!)
- ๐ CI/CD Integration: Automated testing on every push
Outstanding Achievements:
- ๐ Perfect Test Score: 100% pass rate across all test suites
- โ
Complete CRUD Operations: All create, read, update, delete operations flawless
- โ
Advanced Error Handling: Comprehensive edge case validation
- โ
Idempotency Testing: PUT/DELETE operations perfectly implemented
- โ
Performance Validation: All timing and efficiency tests passed
- โ
Production-Ready API: Fully validated for enterprise use
- โ
CI/CD Excellence: Automated testing pipeline working seamlessly
๐ง How to Use Keploy Testing
1. Manual API Testing
# Start the server
npm start
# Run manual API tests
chmod +x api-test-commands.sh
./api-test-commands.sh
2. Keploy AI Testing (Local)
# Install Keploy CLI
curl --silent --location "https://github.com/keploy/keploy/releases/latest/download/keploy_linux_amd64.tar.gz" | tar xz
sudo mv keploy /usr/local/bin/
# Start your application
npm start
# Run Keploy tests
keploy test --config-path ./keploy.yml
3. CI/CD Pipeline Testing
Our GitHub Actions workflow automatically:
- โ
Runs unit and integration tests
- โ
Starts the API server
- โ
Executes Keploy AI API tests
- โ
Validates all endpoints
- โ
Generates test reports
- โ
Deploys to staging (on main branch)
๐ API Testing Files
TaskMaster-API/
โโโ openapi.yaml # OpenAPI 3.0 specification
โโโ keploy.yml # Keploy configuration
โโโ api-test-commands.sh # Manual cURL testing script
โโโ .github/workflows/ # CI/CD pipeline
โ โโโ keploy-ci.yml # Keploy integration workflow
โโโ keploy/ # Keploy test files (auto-generated)
โโโ test-set-1/
โโโ test-1.yaml # Health check test
โโโ test-2.yaml # Get tasks test
โโโ test-3.yaml # Create task test
โโโ test-4.yaml # Statistics test
๐ฏ Tested API Endpoints
| Method |
Endpoint |
Description |
Status |
| GET |
/health |
Health check |
โ
|
| GET |
/api/tasks |
Get all tasks |
โ
|
| GET |
/api/tasks/:id |
Get specific task |
โ
|
| POST |
/api/tasks |
Create new task |
โ
|
| PUT |
/api/tasks/:id |
Update task |
โ
|
| DELETE |
/api/tasks/:id |
Delete task |
โ
|
| GET |
/api/stats |
Get statistics |
โ
|
| GET |
/api/tasks?status=pending |
Filter by status |
โ
|
| GET |
/api/tasks?priority=high |
Filter by priority |
โ
|
๐ CI/CD Pipeline Stages
graph LR
A[Code Push] --> B[Unit Tests]
B --> C[API Testing with Keploy]
C --> D[Security Scan]
D --> E[Deploy to Staging]
E --> F[Post-deployment Tests]
Loading
๐ Test Reports & CI/CD Configuration
๐ View Live Results:
๐ง CI/CD Pipeline Features:
- โ
Automated Keploy Testing on every push and pull request
- โ
Manual Workflow Triggers for on-demand testing
- โ
Test Log Artifacts automatically saved and uploaded
- โ
Node.js 20 with pnpm package management
- โ
Production Environment Testing against live Vercel deployment
๐ Key Files:
๐ Quick Start
-
Try Live Demo
-
Local Setup (3 commands)
git clone https://github.com/alienx5499/TaskMaster-API.git
cd TaskMaster-API && npm install && npm rebuild sqlite3
npm start # Visit http://localhost:3002
-
Start Managing Tasks
- Create, read, update, and delete tasks through the beautiful UI
- Test API endpoints using the built-in interface
- Explore real-time task management with modern animations
๐ ๏ธ Developer Tools
TaskMaster-API includes essential developer tools and utilities to enhance the development experience, test API functionality, and monitor application behavior.
๐ API Testing
Built-in Test Utility
# Run comprehensive API tests
node test-api.js
Manual API Testing
# Test all endpoints manually
curl http://localhost:3002/api/tasks
curl -X POST http://localhost:3002/api/tasks -H "Content-Type: application/json" -d '{"title":"Test Task","description":"Test Description"}'
๐ Development & Debugging
Server Logs
- Real-time request logging with timestamps
- Error tracking and stack traces
- Database operation monitoring
- Performance metrics tracking
Database Management
# View database file
ls -la tasks.db
# Reset database (removes all data)
rm tasks.db && npm start
โก Quick Development Setup
-
Start Development Server:
npm start
# Server runs on http://localhost:3002
-
Test API Endpoints:
-
Access Frontend:
๐ง Available Tools
๐ API Documentation
- Complete endpoint reference in
API_DOCUMENTATION.md
- Request/response examples
- Error code explanations
- Usage guidelines
๐งช Testing Utilities
- Automated test suite (
test-api.js)
- CRUD operation testing
- Error handling verification
- Performance benchmarking
๐ Comprehensive Test Coverage
We've implemented a complete testing suite with 70%+ code coverage including:
- Unit Tests: Input validation, middleware, and business logic testing
- Integration Tests: Database operations and server integration
- API Tests: Complete endpoint coverage (100% of all 6 endpoints)
- Performance Tests: Load testing and response time verification
Test Coverage Results:

Available Test Commands:
# Run all tests with coverage
npm test
# Run specific test types
npm run test:unit # Unit tests only
npm run test:integration # Integration tests only
npm run test:api # API endpoint tests only
# Development testing
npm run test:watch # Watch mode for development
npm run coverage # Generate detailed coverage report
Test Results Summary:
- โ
85+ test cases
- โ
82.48% statement coverage
- โ
84.26% branch coverage
- โ
95.45% function coverage
- โ
100% API endpoint coverage
๐ Monitoring & Logging
- Console request logging with timestamps
- Database operation tracking
- Error stack trace capture
- Performance timing metrics
๐ Development Helpers
# Check server status
curl http://localhost:3002/health
# View database schema
sqlite3 tasks.db ".schema"
# Monitor real-time logs
npm start # Watch console output
๐จ Troubleshooting
Common Issues
-
SQLite3 Binding Errors (macOS/Linux)
# Rebuild SQLite3 native bindings
npm rebuild sqlite3
# Or clean install with force
rm -rf node_modules pnpm-lock.yaml
pnpm install --force
npm rebuild sqlite3
-
Server Not Starting
# Check if port is already in use
lsof -i :3002
# Start with different port
PORT=3003 npm start
# Check Node.js version (requires 14+)
node --version
-
Database Connection Issues
// Check database file permissions
ls -la tasks.db
// Recreate database (will lose data)
rm tasks.db
npm start // Will auto-create new database
-
API Request Failures
# Test API endpoints
curl http://localhost:3002/api/tasks
# Check server logs for errors
npm start // Check console output
# Test with API testing utility
node test-api.js
-
Frontend Loading Issues
# Clear browser cache
Ctrl+Shift+R (Windows/Linux)
Cmd+Shift+R (Mac)
# Check if static files are served
curl http://localhost:3002/
# Verify public folder exists
ls -la public/
๐ฏ Best Practices
-
Development Workflow
- Always test API endpoints after changes
- Use the built-in test utility for comprehensive testing
- Monitor server logs for debugging
- Regularly check database integrity
-
API Testing
- Test all CRUD operations thoroughly
- Verify error handling for edge cases
- Check response times and performance
- Validate data integrity and persistence
-
Debugging Strategy
- Use server console logs for systematic debugging
- Leverage SQLite3 tools for database inspection
- Monitor API response patterns
- Track request/response cycles
๐ก Pro Tip: Use node test-api.js regularly during development to catch API issues early and ensure consistent functionality.
๐จโ๐ง Detailed Setup
Prerequisites
- Node.js (v16.10.0 or higher)
- npm or pnpm package manager
- Git for version control
Installation Steps
-
Clone the Repository
git clone https://github.com/alienx5499/TaskMaster-API.git
-
Navigate to Project Directory
-
Install Dependencies
npm install
# or
pnpm install
-
Rebuild SQLite3 (if needed)
-
Start the Server
npm start
# Server will start on http://localhost:3002
-
Open in Browser
- Visit
http://localhost:3002
- Start exploring task management operations!
-
Test API Endpoints (Optional)
# Run API tests
node test-api.js
# Or test manually
curl http://localhost:3002/api/tasks
๐ฏ Target Audience
๐จโ๐ Students
- Visual learning of task management operations
- Understanding time complexity
- Operation comparison and analysis
๐จโ๐ซ Educators
- Interactive teaching tool
- Operation demonstration
- Performance visualization
๐จโ๐ป Developers
- Operation implementation reference
- Performance optimization insights
- Code structure examples
๐ Data Enthusiasts
- Operation behavior analysis
- Performance comparison
- Data structure visualization
๐ค Contributing
We โค๏ธ open source! Your contributions make this project better.
How to Contribute
-
Fork the Repository
git clone https://github.com/your-username/TaskMaster-API.git
-
Create Feature Branch
git checkout -b feature/amazing-feature
-
Commit Changes
git commit -m "Add amazing feature"
-
Push to Branch
git push origin feature/amazing-feature
-
Open Pull Request
Contribution Guidelines
- Follow the existing code style
- Add tests for new features
- Update documentation
- Keep commits clean and meaningful
Awesome Contributors
Thank you for contributing to our repository
๐ License
This project is licensed under the MIT License - see the LICENSE file for details.
๐ฌ Feedback & Suggestions
We value your input! Share your thoughts through GitHub Issues.
๐ก Let's work together to enhance the understanding of task management operations!