Forumify Platform

https://github.com/forumify/forumify-platform

Admin

A modern open-source forum experience that brings forums back to the modern era, built on Symfony...

Tokens:915

Snippets:21

Trust Score:7.2

Update:5 months ago

Show doc for...

Tokens:

Raw

### Run Tests Locally (Linux/WSL/MacOS)

Source: https://github.com/forumify/forumify-platform/blob/master/README.md

Execute this command to run PHPUnit tests locally. This helps ensure the stability and correctness of the platform.

```bash
make tests
```

--------------------------------

### Run Quality Checks Locally (Linux/WSL/MacOS)

Source: https://github.com/forumify/forumify-platform/blob/master/README.md

Execute this command to perform code style and static analysis checks locally. Ensures code quality before creating a pull request.

```bash
make quality
```

--------------------------------

### Run PHPStan Static Analysis Locally

Source: https://github.com/forumify/forumify-platform/blob/master/CONTRIBUTING.md

Perform static analysis on the codebase using PHPStan locally. This helps identify potential bugs and type errors.

```bash
./vendor/bin/phpstan analyze
```

--------------------------------

### Add Forumify Platform to Composer Repositories

Source: https://github.com/forumify/forumify-platform/blob/master/README.md

Add this to your composer.json to symlink the forumify-platform for local development. This allows changes to be immediately available.

```json
    "repositories": [
        {
            "type": "path",
            "url": "../forumify-platform"
        }
    ]
```

--------------------------------

### Run PHPUnit Tests Locally

Source: https://github.com/forumify/forumify-platform/blob/master/CONTRIBUTING.md

Execute the PHPUnit test suite locally to ensure code quality before submitting a pull request. This command checks the functionality of the codebase.

```bash
./vendor/bin/phpunit
```

--------------------------------

### Run PHPCS Code Style Check Locally

Source: https://github.com/forumify/forumify-platform/blob/master/CONTRIBUTING.md

Check the code against PSR-12 standards using PHPCS locally. This ensures consistent code style across the project.

```bash
./vendor/bin/phpcs
```

Tokens:

Raw