Merge branch 'main' into deta-deploy

Author: IIvexII

README.md

@@ -1,57 +1,96 @@
-<h1 align="center">LGU-TimetableAPI</hello>
+<h1 align="center">
+  <br>
+  <a href="https://timetable.lgu.edu.pk"><img src="https://user-images.githubusercontent.com/41378765/200201356-6ebba91a-dec8-4314-93ff-3b7268c4274c.png" alt="Lahore Garrison University" width="500"></a>
+  <br>
+  Timetable API
+  <br>
+</h1>
+
+<h4 align="center">Blazingly fast, lightweight and easy to use.</h4>
+
+<p align="center">
+  <a href="#"><img src="https://img.shields.io/badge/node-18.7.0-success"alt="Node 18.7.0"></a>
+  <a href="#"><img src="https://img.shields.io/badge/API-v1.0-informational"></a>
+  <a href="#"><img src="https://img.shields.io/github/repo-size/iivexii/LGU-TimetableAPI"></a>
+  <a href="#">
+    <img src="https://img.shields.io/github/forks/iivexii/LGU-TimetableAPI?color=30b781">
+  </a>
+ <a href="#">
+    <img src="https://img.shields.io/github/stars/iivexii/LGU-TimetableAPI">
+  </a>
+ 
+</p>
 
-<h5 align="center"> Unofficial API for the timetable of Lahore Garrison University. </h5>
+<p align="center">
+  <a href="#key-features">Key Features</a> • 
+  <a href="#how-to-use">How To Use</a> • 
+  <a href="#download">Download</a> • 
+  <a href="#routes">Routes</a> • 
+  <a href="#credits">Credits</a> • 
+  <a href="#used-by">Used By</a> • 
+  <a href="#our-contributors">Contributors</a> •
+  <a href="#license">License</a>
+</p>
 
-### Routes
-All Routes requires these parameters: `session`, `semester`, `degree`, `section`
-| Route                      | Special Params             | Description    |
-|----------------------------|:------------:|:----------------|
-| `/`                        | _            | Fetch the timetable from `timetable.lgu.edu.pk` and return it in **JSON format**|
-| `/gc-integration`            | _            | Create events on google calendar based on the official timetable.               |
+<div align='center'><img src='https://user-images.githubusercontent.com/41378765/200203572-b2e45699-0d3e-423a-b9a6-2cc2578578ef.gif' width='1024'></div>
 
-<br>
 
-### Technologies used 🛠
+## Key Features
 
-<p align="left"> 
+* 📑 Provide data in **JSON**
+* 🤝 APIs for all the important data like `semesters`, `degrees`, `sections` and `timetable`
+* ⚡ Fast and easy to use
+* 🔻 ligneweight with avg response size of `633.38 bytes` per request
 
- <img src="https://img.shields.io/badge/JavaScript-323330?style=for-the-badge&logo=javascript&logoColor=F7DF1E">
- <img src="https://img.shields.io/badge/Node.js-43853D?style=for-the-badge&logo=node.js&logoColor=white">
- <img src="https://img.shields.io/badge/Express.js-404D59?style=for-the-badge">
- 
- <br>
- 
- ### Complete documents about project  📘
- - please read [how to Setup](Docs) before diving into project.
- <br><br>
+## How To Use
+
+To clone and run this application, you'll need [Git](https://git-scm.com) and [Node.js](https://nodejs.org/en/download/) (which comes with [npm](http://npmjs.com)) installed on your computer. From your command line:
+
+```bash
+# Clone this repository
+$ git clone https://github.com/IIvexII/LGU-TimetableAPI.git
+
+# Go into the repository
+$ cd LGU-TimetableAPI
 
-### See any issue ? ☠
-Create an issue with the correct label.
-<br><br>
+# Install dependencies
+$ npm install
 
-### For folks who wants to contribute ❤
-- please read [how to contribute](https://github.com/IIvexII/LGU-TimetableAPI/blob/main/CONTRIBUTING.md) before getting started.
+# Run the app
+$ npm start
+```
 
+> **Note**
+> If you're using Linux Bash for Windows, [see this guide](https://www.howtogeek.com/261575/how-to-run-graphical-linux-desktop-applications-from-windows-10s-bash-shell/) or use `node` from the command prompt.
 
- Clone the repo in your own local machine
-Comment on the issue and we will reserve it for you. &nbsp;🌈 &nbsp; ✨
 
+## Download
 
-Your contribution is highly appreciated 🙏.</br>
+You can [download](https://github.com/IIvexII/LGU-TimetableAPI/releases/tag/v1.0) the latest installable version of Timetable API for Windows, macOS and Linux.
 
+## Routes
 
+| Route                      | Special Params             | Description                                            | Example                   |
+|----------------------------|:--------------------------:|:------------------------------------------------------:|---------------------------|
+| GET `/semesters`           | _                          | return a **JSON** Object containing semesters.         | [demo](https://lgu-timetable-api.deta.dev/semesters)|
+| GET `/degrees`              | `semester`                | all the degree programs in a specific semester.        | [demo](https://lgu-timetable-api.deta.dev/degrees?semester=5)|
+| GET `/sections`              | `semester`,`degree`      | all the section in a semester with via degree program. | [demo](https://lgu-timetable-api.deta.dev/sections?semester=1&degree=BSCS)|
+| GET `/timetable`              | `semester`, `degree`, `section`      | all the degree programs in a specific semester.| [demo](https://lgu-timetable-api.deta.dev/timetable?semester=3&degree=BSCS&section=A)|
 
 
-### Example
-[Get Timetable in JSON](https://lgu-timetable-api.deta.dev?session=jjedrbhv59rmhc871qs1i7gv97&semester=5&degree=BSCS&section=A) - **Note**: Login and provide session as paramtere
-<br><br>
+## Credits
 
-## Repo Status
+This software uses the following open source packages:
+
+- [Node.js](https://nodejs.org/)
+- [Express.js](https://expressjs.com/)
+- [Shield.io](https://shields.io/)
+- [JSDOM](https://github.com/jsdom/jsdom)
+
+## Used By
+
+[LGU Timetable Front-end](https://github.com/Zain-ul-din/LGU-BetterTimeTable) - Lightweight timetable frontend on top of this API.
 
-![GitHub Issues Open](https://img.shields.io/github/issues/IIvexII/LGU-TimetableAPI?style=for-the-badge&color=green)
-![GitHub PR Open](https://img.shields.io/github/issues-pr/IIvexII/LGU-TimetableAPI?style=for-the-badge&color=aqua)
-![GitHub PR closed](https://img.shields.io/github/issues-pr-closed-raw/IIvexII/LGU-TimetableAPI?style=for-the-badge&color=blue)
-![GitHub language count](https://img.shields.io/github/languages/count/IIvexII/LGU-TimetableAPI?style=for-the-badge&color=brightgreen)
 
 ## Our Contributors 
 
@@ -63,3 +102,7 @@ Your contribution is highly appreciated 🙏.</br>
 <h4 font-weight="bold">This repository is maintained by <a href="https://github.com/IIvexII">IIvexII</a></h4>
 <p> Show some ❤️ by starring this awesome repository! </p>
 </div>
+
+## License
+
+MIT -  ✔️ Commercial use  ✔️ Modification ✔️ Distribution ✔️ Private use 

src/controllers/TimetableController.js

@@ -86,6 +86,27 @@ class TimetableController {
 
     res.send(timetable?.timetable);
   }
+  static async getMetadata(req, res) {
+    const sections = await Section.find({});
+    const metadata = {};
+
+    for (let section of sections) {
+      if (metadata[section.degree.semester.name]?.length > 0) {
+        metadata[section.degree.semester.name].push({
+          degree: section.degree.degreeName,
+          section: section.sectionTag,
+        });
+      } else {
+        metadata[section.degree.semester.name] = [
+          {
+            degree: section.degree.degreeName,
+            section: section.sectionTag,
+          },
+        ];
+      }
+    }
+    res.send(metadata);
+  }
 }
 
 module.exports = { TimetableController };

src/routes/TimetableRouter.js

@@ -4,6 +4,7 @@ const { TimetableController } = require('../controllers');
 
 const router = Router();
 
+router.get('/metadata', TimetableController.getMetadata);
 router.get('/semesters', TimetableController.getSemesters);
 router.get('/degrees', TimetableController.getDegrees);
 router.get('/sections', TimetableController.getSections);