README.md

Laravel API Boilerplate

The api boilerplate build on Laravel 8, this using to start a project with api faster.

---

System requirements

1. PHP >=7.2

2. Nodejs >=10.22.1

3. Docker Engine >=19.03.13

4. Docker compose >=1.27.4

5. mkcert - Install mkcert & generate key following the guide

6. cz-cli - Support convention of message when commit to repo. Install following the guide

Installation

Start web server with docker-compose (https)

docker-compose up -d

docker-compose exec -T <service_api_name> cp .env.example .env

docker-compose exec -T <service_api_name> composer install

docker-compose exec -T <service_api_name> php artisan key:generate

docker-compose exec -T <service_api_name> php artisan migrate --seed

Run test & linter

docker-compose exec -T <service_api_name> vendor/bin/phpunit

docker-compose exec -T <service_api_name> vendor/bin/phpcs

Run fixer for coding style

docker-compose exec -T <service_api_name> vendor/bin/phpcbf

Run command line to update changelogs following standard-version

yarn release -- --prerelease

Commit an task follow cz-cli

git add </file>

cz

git push to branch

Maintained by: KUN

License

MIT