Laravel-Portugal API

Installation

Requirements

• PHP >= 7.4
• MySQL >= 8, MariaDB >= 10 or PostgreSQL >= 11

Steps to activate this project

1. Clone this repository.
2. Run composer install to install all dependencies (add --no-dev if you're using this in production).
3. Run cp .env.example .env to create an .env file based on the distributed .env.example file.
4. Update the .env file with a new APP_KEY and the connection details for the database.
5. Run php artisan migrate to create the database schema.

Testing

This project is fully tested. We have an automatic pipeline and an automatic code quality analysis tool set up to continuously test and assert the quality of all code published in this repository, but you can execute the test suite yourself by running the following command:

vendor/bin/phpunit

Note: This assumes you've run composer install (without the --no-dev option).

We aim to keep the master branch always deployable. Exceptions may happen, but they should be extremely rare.

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

Please see SECURITY for details.

Credits

• José Postiga
• All Contributors

License

The MIT License (MIT). Please see License File for more information.