deshmukhmayur / diems-app-backend

API for the DIEMS Application

DIEMS College App JSON API Service

The API Service for the College App of DIEMS, Aurangabad. It provides database handling and other back-end functionality for the Android App and the upcoming Web App.

Built with:

• Slim3 - a micro-framework for PHP
• Eloquent - an ORM for PHP, developed by Laravel

Usage

For details on how to use this API and it's endpoints, refer to the wiki.

Installation

Requirements

The following components should be pre-installed:

• A web server (Recommended: Apache)
• PHP (Recommended: 7.x)
• A Database Engine (Recommended: MariaDB / PostgreSQL)

Configuration

Clone this Repository:

$ git clone https://github.com/deshmukhmayur/diems-app-backend.git

Install the dependencies:

$ php composer.phar install

After cloning the repository, you need to create a new directory config/ in the root and add a settings.php file in it containing your database and credentials. For eg.

// config/settings.php

$settings = array(
    'driver' => 'mysql',
    'host' => 'localhost',
    'database' => 'database',
    'username' => 'username',
    'password' => 'password',
    'collation' => 'utf8_general_ci',
    'prefix' => '',
);

Running the server:

To run the development server

$ php -S 0.0.0.0:8880 -t public

Contributing

For details on contributing to this project read the CONTRIBUTING file.

License

This project is licensed under the Apache-2.0. See the LICENSE file for details.