Developers

This Page has information for Developers, who would like to contribute to the IITMConnect Application.
The IITMConnect App is built on Laravel Framework.

Set up IITMConnect on Localhost

Step 1 - Install Composer

Laravel utilizes Composer to manage its dependencies. First, download a copy of the composer.phar. Once you have the PHAR archive, you can either keep it in your local project directory or move to usr/local/bin to use it globally on your system.

Step 2 - Clone Repository

Clone the repository on your localhost

git clone https://github.com/IAR-Webops/IITMConnect.git

After cloning the repository, install the project dependencies by running

composer install

After following the above instructions, test to see if everything is in order by running the application

php artisan serve

If you run into permission issues refer to the Installation instructions given on the Laravel Framework website. If you want exact commands or are setting up the server from scratch then refer to this Blog Post.

Step 3 - Database Credentials

Enter your db credentials in app/config directory.
Open the file named database.config.example and enter your database credentials under the mysql array. Then rename the file as database.config.
You can refer to the file here

Step 4 - Database Migration

Once you have entered your db credentials, run a db migrate to create the required tables for the IITMConnect App.

php artisan migrate --seed

Make sure you run the command with the --seed attribute, this makes sure that the db is automatically filled with all the static data of Departments, Hostels and Minors.