Merge pull request #4 from dmd-web-and-mobile/develop

Early Preview

.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+[*.php]
+indent_style = tab
+indent_size = 2

.gitignore

@@ -0,0 +1,20 @@
+api/vendor/
+
+# OS generated files
+.DS_Store
+.DS_Store?
+._*
+Thumbs.db
+
+# Logs
+*.log
+
+# Dependency directories
+node_modules
+bower_components
+
+# Build Systems
+.sass-cache
+*.css.map
+build/
+dist/

README.md

@@ -1,6 +1,41 @@
 # Foodbank
 
-Rules Engine and API for Feeding America / Foodbank Project.
+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
 

api/.htaccess

@@ -0,0 +1,4 @@
+RewriteEngine On
+RewriteCond %{REQUEST_FILENAME} !-f
+RewriteCond %{REQUEST_FILENAME} !-d
+RewriteRule ^ index.php [QSA,L]

api/Foodbank.postman_collection.json

@@ -0,0 +1,25 @@
+{
+	"variables": [],
+	"info": {
+		"name": "Foodbank",
+		"_postman_id": "a8e172cf-8f6b-3abf-a0ee-90832eecb2bf",
+		"description": "",
+		"schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json"
+	},
+	"item": [
+		{
+			"name": "GET All Categories",
+			"request": {
+				"url": "http://localhost:8000/category/all",
+				"method": "GET",
+				"header": [],
+				"body": {
+					"mode": "formdata",
+					"formdata": []
+				},
+				"description": ""
+			},
+			"response": []
+		}
+	]
+}

api/composer.json

@@ -0,0 +1,14 @@
+{
+    "name": "brian/foodbank",
+    "type": "project",
+    "authors": [
+        {
+            "name": "briankelleher",
+            "email": "bkelleher4@gmail.com"
+        }
+    ],
+    "require": {
+      "propel/propel": "~2.0@dev",
+        "slim/slim": "~3.0"
+    }
+}