https://github.com/patrickcurl/backend-assessment

This is just an assessment of my skills in php using the Klein router package.
https://github.com/patrickcurl/backend-assessment

Last synced: 3 months ago
JSON representation

This is just an assessment of my skills in php using the Klein router package.

• Host: GitHub
• URL: https://github.com/patrickcurl/backend-assessment
• Owner: patrickcurl
• Created: 2018-02-24T00:18:27.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-02-24T08:33:07.000Z (over 7 years ago)
• Last Synced: 2025-01-25T14:12:05.025Z (5 months ago)
• Language: PHP
• Homepage:
• Size: 1.03 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## Backend Assessment using Klein PHP Router.

This project uses phpdotenv, eloquent, klein.php, and filip/whoops. 

Setup: 

1. Setup environment variables: 

```bash 

    $ cp .env.example .env

``` 

2. Edit .env to match your local mysql settings.

    ```Note the DB_ENGINE must be MyISAM if using mysql version less than 5.6 to support fulltext indexing.``` 

3. point your apache/nginx vhost at public folder.  

    Note for NGINX the most important part was having ```try_files $uri $uri/ /index.php?q=$uri&$args;``` inside the ```location/{...}``` block. 

    

    [See my nginx management tool for help setting up on linux.](https://github.com/patrickcurl/ngTool)

4. From commandline run the following commands: 

    ```bash

       $ php composer install && php vendor/bin/phinx migrate

    ```

Usage: 

Routes are in app/routes.php 

The following routes are setup: 

```

    /**

     * Index of all addresses.

     * (GET) http://back.test/addresses 

     * --> returns json of all addresses from db.

     */

    $route->respond('GET', '/addresses', [$addressController, 'index']);

    /**

     * Search addresses by field and query. I.E. 

     * (GET) http://back.test/addresses/search/field/query

     * $field can be: zipcode or name, 

     * $query is what to match against, examples: 

     * http://back.test/addresses/search/zipcode/84 => 84604, 84601, etc would match.

     * http://back.test/addresses/search/name/ho => house, home, etc would match.

     */

    $route->respond('GET', '/addresses/search/[:field]/[:query]', [$addressController, 'search']);

    /**

     * Create address.

     * (POST) http://back.test/addresses 

     * all fields except address_2 are required and must meet validations. 

     * Zipcode is numeric 5-10 chars, all others are alphanumeric, spaces, hyphens, and underscores. 

     * address_2 has no validations as it's not required. 

     */

    $route->respond('POST', '/addresses', [$addressController, 'store']);

```