Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 2 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<h1 align='center'> LGU-TimetableAPI <h1>
<h5 align='center'>Unofficial API for the timetable of Lahore Garrison University.<h5>
# LGU-TimetableAPI
Unofficial API for the timetable of Lahore Garrison University.

### Routes
All Routes requires these parameters: `session`, `semester`, `degree`, `section`
Expand All @@ -8,40 +8,5 @@ All Routes requires these parameters: `session`, `semester`, `degree`, `section`
| `/` | _ | 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. |

<br>

### Technologies used 🛠

<p align="left">

<img src="https://img.shields.io/badge/JavaScript-323330?style=for-the-badge&logo=javascript&logoColor=F7DF1E">
<img src="https://img.shields.io/badge/shell-1572B6?style=for-the-badge&logo=shell&logoColor=white">

<br>

### Complete documents about project 📘
- please read [how to Setup](Docs) before diving into project.
<br><br>

### See any issue ? ☠
Create an issue with the correct label.
<br><br>

### For folks who wants to contribute ❤
- please read [how to contribute](https://github.com/IIvexII/LGU-TimetableAPI/blob/main/CONTRIBUTING.md) before getting started.


Clone the repo in your own local machine
Comment on the issue and we will reserve it for you. &nbsp;🌈 &nbsp; ✨


Your contribution is highly appreciated 🙏.</br>




### 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>

> This repository is maintained by [IIvexII](https://github.com/IIvexII). </br>