college-portal/api-models

Models for Database Tables and Views for the College-Portal project

dev-master 2018-08-25 15:24 UTC

Requires

• illuminate/auth: ^5.6
• illuminate/contracts: ^5.6
• illuminate/database: ^5.6
• illuminate/notifications: ^5.6
• illuminate/support: ^5.6
• mykeels/laravel-filters: dev-master

Requires (Dev)

• evert/phpdoc-md: ^0.2.0
• phpstan/phpstan: ^0.10.2
• squizlabs/php_codesniffer: ^3.3

MIT

• Ikechi Michael

README

This laravel package contains Eloquent Models and Traits and help power data-access for the College-Portal project.

Setup

• Run composer require college-portal/api-models in your terminal to pull the package in.

Standards

• This package is built and linted with the PSR-2 standard.
  • Run composer run lint to check linter errors
  • Run composer run fix-lint to fix linter errors
• A static analyser is used to make sure code works statically.
  • Run composer run analyse to verify.

Code Documentation

See Code Documentation, which is generated with this package.

To generate the docs after making code changes, run composer run docs