This Repo has the REST APIs for the hadba WebApp
- Main features
- Technology stack
- Quick start
- Documentation
- Contributing
- Versioning
- Copyright and license
hadba is a WebApp for collecting semester wise feedbacks from the students, it can do the following things in ease.
- Add Faculty and subject information
- Feed the timetable of each class
- Conduct feedback of sessions of each class
- Generate PDF Reports
hadba - API uses the following technologies:
- Composer - Dependency Manager for PHP
- Slim Framework - PHP micro framework for web applications and APIs.
- Monolog - Logging for PHP.
- Apidoc - Inline Documentation for RESTful web APIs
- MySQL - The world's most popular open source database
- PHP - PHP is a popular general-purpose scripting language for web development
- Web server (such as Apache, nginx, IIS)
- PHP 5.3.2 or above (at least 5.3.4 recommended to avoid potential bugs)
- Database
- MySQL 5.5 or newer
- MariaDB 5.5 or newer
- Clone the repo:
git clone https://github.com/pratheekhegde/hadba-API.git - Install with composer:
php composer.phar - Get the server up and running.
That's it, if everything went well you should be able to hit the APIs from outside.
hadba - API's documentation, included in this repo in the docs directory, is built with Apidoc and publicly hosted on GitHub Pages at http://pratheekhegde.github.io/hadba-API/doc/. The docs may also be run locally.
- Install apidoc from
npm install apidoc. - Run
apidoccommand to build/rebuild documentation files from the PHP code. - From the root
/docsdirectory, run a http server or open the directory from a web browser to view the documentation.
If you are interested contributing to this project please contact me. ✌️
The Semantic Versioning guidelines will be followed once the v4 build is stable. 😬
This code is under MIT license.