README.md

All endpoints are covered with tests, which can be found in tests folder.

Instructions

Requirements

• PHP 8
• Composer
• PostgreSQL

Getting started

1. Install dependencies:

composer install

2. Make a new configuration file:

cp .env.example .env

3. Generate encryption key:

php artisan key:generate

4. Edit .env file to set your database credentials.

5. Execute database migrations and run "seeding" by using --seed option:

php artisan migrate --seed

Running tests

php artisan test

Preview docs locally

php artisan scribe:generate
php -S 127.0.0.1:4000 -t=docs