Reoso Matcher Case Study

Laravel implementation of the case study.

---

Getting started

Installation

Installation is possible without local dependencies relying on Docker.

Clone the repository

git clone [email protected]:DanielRobert1/reoso_matcher.git

Switch to the repo folder

cd reoso_matcher

Install all the dependencies using composer

composer install

Copy the example env file and make the required configuration changes in the .env file

cp .env.example .env

Generate a new application key

php artisan key:generate

Run the database migrations (Set the database connection in .env before migrating)

php artisan migrate

Start the local development server

php artisan serve

You can now access the server at http://localhost:8000

TL;DR command list

git clone [email protected]:DanielRobert1/reoso_matcher.git
cd reoso_matcher
composer install
cp .env.example .env
php artisan key:generate

Make sure you set the correct database connection information before running the migrations Environment variables

php artisan migrate
php artisan serve

Database seeding

Populate the database with seed data with relationships which includes property_types, properties, search_profiles. This can help you to quickly start testing the api.

Run the database seeder and you're done

php artisan db:seed

Note : It's recommended to have a clean database before seeding. You can refresh your migrations at any point to clean the database by running the following command

php artisan migrate:refresh

The api can be accessed at http://localhost:8000/api.

Code overview

Folders

• app/Models - Contains all the Eloquent models
• app/Repositories - Contains all the Repositories
• app/Http/Controllers/Api - Contains all the api controllers
• config - Contains all the application configuration files
• database/factories - Contains the model factory for all the models
• database/migrations - Contains all the database migrations
• database/seeds - Contains the database seeder
• routes - Contains all the api routes defined in api.php file
• tests - Contains all the application tests

Environment variables

• .env - Environment variables can be set in this file

Note : You can quickly set the database information and other variables in this file and have the application fully working.

---

Testing API

Run the laravel development server

php artisan serve

The api can now be accessed at

http://localhost:8000/api

Request headers

Required	Key	Value
Yes	Content-Type	application/json
Yes	X-Requested-With	XMLHttpRequest