tmu-courses-api/README.md

A comprehensive dataset and API for Toronto Metropolitan University (TMU) programs and courses.

# TMU Courses API

A comprehensive dataset and API for Toronto Metropolitan University (TMU) programs and courses.

---

## 🧭 Overview

This project provides:

- **A public REST API server** hosted at [https://tmu-courses-api.onrender.com](https://tmu-courses-api.onrender.com) to fetch TMU programs and course data.  
- **An NPM package** (`tmu-courses-api`) for local, offline access to the same data in any Node.js project — no internet required.

---

## 🚀 Quick Start

### 📡 Using the Public API Server

Fetch TMU programs and courses directly from our hosted API.

**Base URL:**  
https://tmu-courses-api.onrender.com

#### 🔗 Available Endpoints

| Endpoint                | Description                        | Example Request                                                                 |
|------------------------|------------------------------------|---------------------------------------------------------------------------------|
| `/programs`            | Get all program names              | GET https://tmu-courses-api.onrender.com/programs                               |
| `/programs/:program`   | Get all courses in a program       | GET https://tmu-courses-api.onrender.com/programs/Computer Science              |
| `/course/:code`        | Get course details by course code  | GET https://tmu-courses-api.onrender.com/course/CPS 109                         |

#### 💡 Example Usage (via curl)

    # Get all programs
    curl https://tmu-courses-api.onrender.com/programs

    # Get courses for a specific program
    curl https://tmu-courses-api.onrender.com/programs/Accounting

    # Get specific course details
    curl https://tmu-courses-api.onrender.com/course/ACC 100

---

### 📦 Using the NPM Package

Install the package for local/offline usage:

    npm install tmu-courses-api

#### 🛠 Basic Usage

    const tmuCourses = require('tmu-courses-api');

    // Get all program names
    console.log(tmuCourses.getPrograms());

    // Get all courses for the "Computer Science" program
    console.log(tmuCourses.getCoursesByProgram('Computer Science'));

    // Get details for a specific course
    console.log(tmuCourses.getCourseByCode('ACC 100'));

#### ✅ Key Features

- **Offline access** to all TMU course data  
- **No rate limits** or network latency  
- **Regular updates** aligned with each academic term  

---

## 📚 Data Sources

All course and program data is sourced from:

- The [TMU Official Academic Calendar](https://www.torontomu.ca/calendar/)  
- Published course syllabi  
- Verified across multiple academic years and semesters  

---

## 🤝 Contributing

We welcome contributions! You can:

- 🐛 Report issues or data inaccuracies via [GitHub Issues](#)  
- 🌟 Suggest new features or endpoints  
- 🔧 Submit pull requests for improvements or bug fixes  

---

## 📄 License

MIT © 2023–2025 TMU Courses API
"""