akssshh/LGU-TimetableAPI

Unofficial API for the timetable of Lahore Garrison University.

Timetable API

Blazingly fast, lightweight and easy to use.

Key Features • How To Use • Download • Routes • Credits • Used By • Contributors • License

Key Features

• 📑 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

How To Use

To clone and run this application, you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:

# Clone this repository
$ git clone https://github.com/IIvexII/LGU-TimetableAPI.git

# Go into the repository
$ cd LGU-TimetableAPI

# Install dependencies
$ npm install

# Run the app
$ npm start

Note If you're using Linux Bash for Windows, see this guide or use node from the command prompt.

Download

You can download the latest installable version of Timetable API for Windows, macOS and Linux.

Routes

Method	Route	Special Params	Description	Example
GET	/semesters	_	return a JSON Object containing semesters.	demo
GET	/degrees	semester	all the degree programs in a specific semester.	demo
GET	/sections	semester,degree	all the section in a semester with via degree program.	demo
GET	/timetable	semester, degree, section	all the degree programs in a specific semester.	demo
GET	/metadata	_	all the metadata about sections, semesters and degrees	demo

Credits

This software uses the following open source packages:

• Node.js
• Express.js
• Shield.io
• JSDOM

Used By

LGU Timetable Front-end - Lightweight timetable frontend on top of this API.

Our Contributors

This repository is maintained by IIvexII

Show some ❤️ by starring this awesome repository!

License

MIT - ✔️ Commercial use ✔️ Modification ✔️ Distribution ✔️ Private use