# Getting Started

## Introduction

Phecks (stands for PHP-Checks) is a custom Check Runner. It will run custom checks in your Laravel project and will make a report of violations that need fixing.

By its own, Phecks doesn't contain any checks. You and your team are responsible for defining and imlpementing these checks based on your architectural decisions. Phecks will provide you a framework to develop and run these checks easily.

{% hint style="success" %}
Phecks is recommended for big development teams with an adaptive architecture. Feel free to check [the idea behind phecks](https://juampi92.gitbook.io/phecks/about-phecks/the-idea-behind-it) to understand what kind of problem it's trying to solve.
{% endhint %}

## The Basics

Phecks for now only works for Laravel projects.

It supports PHP >= 7.4, and Laravel >= 8

## Installation

To install phecks in your project, run:

```shell
composer require juampi92/phecks --dev
```

To publish the config file, run:

```shell
php artisan vendor:publish --tag="phecks:config"
```

Get started with the [configuration here](https://juampi92.gitbook.io/phecks/user-guide/configuration).

### Set up

This is the following setup for your Checks:

On your `composer.json`, add:

{% code overflow="wrap" %}

```json
{
    ...
    "autoload-dev": {
        "psr-4": {
            "Phecks\\": "phecks",
            ...
        },
    }
```

{% endcode %}

And create the folder `./phecks/Checks`, where you will place the checks.
