- Docker (https://docs.docker.com/get-docker/)
- NVM (https://github.com/nvm-sh/nvm#installing-and-updating)
cp .env.example .envdocker compose builddocker compose up -ddocker compose exec php composer installdocker compose exec php php artisan key:generatedocker compose exec php php artisan migrate
the API should now be able available at (http://localhost/api/ping)
Run artisan commands with: docker compose exec php php artisan <command>
For PHP testing we are using the Pest framework.
Run PHP unit tests with: docker compose exec php php artisan test
You can connect to the MySQL database with the following credentials:
Host: 127.0.0.1
Port: 4406
Username: root
Password: root
The development docker setup includes Mailpit for catching emails sent from the app.
You can access the Mailpit UI at http://localhost:8025
- Run
composer lintto check coding standards on PHP files. - Run
composer fixto auto-fix coding standards on PHP files.
Pull requests targeting the main branch should reference a Jira task using either the branch name or a commit message, more information can be found here.
This ensures all PRs are linked to a Jira task.
The Open API Spec for this project can be found here