Pet E-Commerce Shop API - Buckhill Challenge

1. Clone the repository git clone [email protected]:mayanksdudakiya/pet-shop-api.git
2. Run the git submodule update --init --recursive to clone both packages currency-converter and state-machine packages
3. Now, cd into project directory using cd pet-shop-api
4. Set your environment variable in .env file cp .env.example .env
5. Run the composer install command
6. Generate the key php artisan key:generate
7. Setup database as you like and run the php artisan migrate:fresh --seed
8. Generate private key for the JWT signing key openssl genpkey -algorithm RSA -out jwt-key.pem
9. Finally, run the php artisan serve

Swagger Api Doc Generation

php artisan l5-swagger:generate

Swagger Api Doc URL

http://127.0.0.1:8000/api/documentation

PHP Insights

php artisan insights

PHPStan Analyse

./vendor/bin/phpstan analyse

Test

php artisan test

Insights Results - Exluding package

Test Results

Swagger API demo

swagger-api-demo.mp4