/foodhut

Primary LanguagePHP

Food Hut

Quality Score Code Quality Vulnerability Github Workflow Status

This is a sample REST API that returns JSON as a response.

Requirements

  • PHP 8.1
  • Laravel 10
  • MailHog
  • Redis
  • MySQL

Project setup

composer install
cp .env.example .env
php artisan key:generate
php artisan migrate --seed

Run development server

php artisan serve

Run queue worker

php artisan cache:clear
php artisan queue:work

Run tests

php artisan test

Generate documentation

php artisan scribe:generate

Note

  • Login credentials
email: testuser@foodhut.com
password: 12345678
  • After generating the documentation, navigate to /docs to view and test the APIs within the generated documentation by clicking on the TRY IT OUT button. A POSTMAN collection can also be exported from the documentation.