README.md

# Foodbank

Rules Engine and API for Feeding America / Foodbank Project.  PHP and MySQL.

## API

Everything is located in the `/api` directory.  You will need [composer](https://getcomposer.org/) installed.

The entire API runs from `index.php`.  This way everything routes to http://foodbankurl.com/api/.

Propel was used to generate the ORM.  The ORM lives under:

```
/api
  /generated-classes  # All of the main ORM classes used in our application.
  /generated-conf     # Configuration for the ORM
  /generated-sql      # Explicit creation queries for our DB structure.
```

The Routing is handled through the `routes` folder, and are [Slim](http://www.slimframework.com/) routes.

### Development

```
cd api
composer install
php -S localhost:8000
```

A `Foodbank.postman_collection.json` file has been added.  You can import this to Postman to test routes.

### Helpful URLs

[Propel ORM Calls](http://propelorm.org/documentation/03-basic-crud.html)

[PHPMyAdmin](http://www.develop.digitalmediauconn.org/phpmyadmin/)

[Routing with Slim](http://www.slimframework.com/docs/objects/router.html#how-to-create-routes)

## Contact

[Joel Salisbury](mailto:joel@uconn.edu) - Faculty Advisor

[Brian Kelleher](mailto:bk@uconn.edu) - Project Manager

[Tim Morris](mailto:timothy.morris@uconn.edu) - Developer

[Gabe Rogan](mailto:gabriel.rogan@uconn.edu) - Developer