About

The petshop api

Installation

To run this project simply clone this rep

git clone git@github.com:SlimGee/petshop-api.git

Install dependencies

cd petshop-api

composer install

yarn install

This project uses spatie/laravel-pdf to generate pdf files, which uses puppeteer. To be on the safe side you might have to install chromium on your machine. You can do that by running the following command

yarn puppeteer browsers install chrome

Usage

Before you can use this project you need to create a .env file in the root directory of the project. You can copy the .env.example file and rename it to .env.

cp .env.example .env

Configure the database connection in the .env file

Migrate the database

php artisan migrate

Seed the database

php artisan db:seed

If you have Laravel Valet installed you can run the project by running the following command

valet open

Otherwise you use the built-in server

php artisan serve

Documentation

Assuming you have valet installed, you can access the documentation by visiting http://petshop-api.test/api/swagger

Or you can visit the /api/swagger route on your local server