ktsirkou / oat-technical-assessment

Introduction

The project is technical assessment for oat.

How to setup

Prerequisites

1. PHP7.2
2. Composer
3. Docker && Docker composer

Run locally

1. Clone the repository

2. Execute composer compoer install

3. Run command docker-compose up -d from the root directory of the project. This make take several minutes.

4. The api should be accessible on localhost:81

5. (optional) you can setup on your hosts file the 127.0.0.1 tao.docker so the api will be also available on this url.

Changing data source

The sources are located under resources path. For now we have the json and csv data sources. Default data source is the json file. To switch sources we only need to update related configuration option found on config/services.yaml. See below

    ...
    
    # by updating the following the parameteres on we can load different data sources from configurable
    # root resources path and filename and resource type. For our exanple changing json to csv is enough for loading
    # the csv resource.
    #the rest of the project remains the same.
parameters:
    app.resource_dir: '%env(REOUSRCE_SOURCE)%'
    app.resource_file_name: 'testtakers'
    app.resource_type: 'json'

    ...

Run tests

php bin/phpunit

You can check with the current default configuration tests are passing. If you check the resource type to csv, tests will fail because we are using separate resources root path that that's include the csv file.

Next steps and Improvements.

1. Support SSL
2. Better validation on query params
3. More efficient filtering, and perhaps adding cache
4. Proper logging, (using sentry)

Check the api online (only http)

• Get users
• Get single User

---