Task Scheduler API

A task scheduling system built with Node, Express, TypeScript, Docker and PostgreSQL. Schedule tasks to run at specific times with priority handling and retry logic.

Quick Start for Contributors

Prerequisites

• Docker & Docker Compose v2
• Git
• Make (optional but recommended)

Setup

1. Clone the repository

git clone https://github.com/0xironclad/Task-Scheduler-API.git
cd Task-Scheduler-API

2. Set up environment variables

cp .env.example .env

3. Start the development environment

make dev-up

4. API is now running at http://localhost:3001

Test it:

curl http://localhost:3001
# {"message":"Hello World"}

Available Commands

Development

make dev-up      # Start dev environment with hot reload
make dev-down    # Stop dev environment
make dev-logs    # View development logs

Production

make up          # Build & run production containers
make down        # Stop production containers
make logs        # View production logs

Database Access

The PostgreSQL database is accessible in development mode only for debugging and inspection.

From Local Machine (TablePlus, DBeaver, pgAdmin Desktop, etc.)

Host: localhost (or 127.0.0.1)
Port: 5433
Username: postgres
Password: postgres
Database: appdb

From Docker Container (pgAdmin4 extension, containerized tools)

Host: host.docker.internal
Port: 5433
Username: postgres
Password: postgres
Database: appdb

Note: In production mode, the database is not exposed and only accessible internally by the API container.

Schema Initialization

The database schema (tables, types, indexes) is automatically created when the containers start for the first time. The initialization script is located at src/data/queries.sql.

If you need to reset the database:

# Development
make dev-down
docker volume rm task-scheduler_dev_pg_data
make dev-up

# Production
make down
docker volume rm task-scheduler_prod_pg_data
make up

Project Structure

src/
├── config/          # Database configuration
├── controller/      # Request handlers
├── data/            # SQL schemas and test utilities
├── middlewares/     # Validation and error handling
├── models/          # Database queries
└── routes/          # API routes

Tech Stack

• Runtime: Node.js with TypeScript
• Framework: Express.js
• Database: PostgreSQL 16
• Validation: Joi
• Dev Tools: tsx for hot reload

Contributing

1. Fork the repo
2. Create a feature branch: git checkout -b feature/your-feature
3. Make your changes
4. Test locally with make dev-up
5. Submit a pull request

API Endpoints

• GET / - Health check
• GET /api/v1/tasks - Get all tasks (with filters)
• POST /api/v1/tasks - Create a new task

More endpoints coming soon!