CAVU API Challenge

Installation

Prerequisites

Make sure you have the following installed on your system before proceeding with the installation:

• PHP ^8.0
• Composer
• Laravel 10
• Laravel Valet (optional, for local development with Valet)

General Installation Steps

1. Clone the repository to your local machine

git clone https://github.com/ogunsakin01/cavu-test.git

2. Change into the project directory

cd cavu-test

3. Install project dependencies using Composer:

composer install

4. Copy the .env.example file to create a new .env file

cp .env.example .env

5. Generate the application key

php artisan key:generate

6. Update the database connection settings in the .env file according to your database setup

DB_CONNECTION=****
DB_HOST=****
DB_PORT=****
DB_DATABASE=****
DB_USERNAME=****
DB_PASSWORD=****

7. Run database migrations and seed the database

php artisan migrate --seed

8. Clear the application cache

php artisan optimize:clear

Starting the application

To start the application, you can use the built-in Laravel development server

php artisan serve

or you can directly use PHP built-in server

php -S localhost:8000 -t public/

or if you choose to use Laravel Valet, run the command below to have it available at http://cavu.test

valet link

or if you wish to test locally with SSL, run the command below to have it available at https://cavu.test

valet secure

Running Tests

To run the tests for the application, you can use either of the following commands

php artisan test

or use

vendon/bin/phpunit

Make sure to run these commands from the root folder of the application. The tests will help ensure that the application functions as expected and that any changes made in the future do not introduce regressions.

API Documentation

The API documentation can be found at https://documenter.getpostman.com/view/3172372/2s9YsNcUxg