Mukellef Backend Challenge Case Study

Developer Notes

• .env file tracked/pushed intentionally
• Developed on Windows 11 - WSL2 - Ubuntu Subsystem

Requirements

• Stable version of Docker
• Compatible version of Docker Compose

How To Deploy

For first time only !

• git clone https://github.com/ErayerA/sdp-api.git
• cd sdp-api
• docker compose up -d --build
• docker compose exec phpmyadmin chmod 777 /sessions
• docker compose exec php bash
• chown -R www-data:www-data /var/www/storage /var/www/bootstrap/cache
• chmod -R 775 /var/www/storage /var/www/bootstrap/cache
• composer setup

From the second time onwards

• docker compose up -d

IMPORTANT:

Don't forget to run artisan, composer, etc. commands in php container. Jump there by:

• docker compose exec php bash

Don't forget to run queue

• php artisan queue:listen

Fix ownership & permissions of files created by artisan:

• sh owners.sh

Postman Instructions

1. Fill client_secret envrionment variable with the same field's value of the only existing row in oauth_clients db table
2. Run GetAccessToken request first and let the token to be saved to environment.

Notes

Anytime for a fresh start

• php artisan migrate:fresh --seed

Command for renewing subscriptions

• php artisan app:renew-subscriptions

Postman Collection

• <project_root>/SDP.postman_collection.json

Postman Rough API Docs

• Published Docs

Laravel App

• URL: http://localhost

Mailpit

• URL: http://localhost:8025

phpMyAdmin

• URL: http://localhost:8080
• Server: db
• Username: mukellef
• Password: mukellef
• Database: main