README

Forumify Platform

A modern open-source forum experience

Forumify is a community platform that brings forums back to the modern era. Built on top of Symfony, and using a simple barebones front-end, it's easy to get into for both community owners and developers alike.

Project Overview

Forumify consists of several different open-source repositories, forumify-platform being the main one.

• Forumify Platform: The platform itself.
• Forumify Docs: Official documentation.
• Forumify Production Template: A template to easily launch forumify.
• Forumify Docker Image: A docker image that wraps the production template.
• Flex Recipes: Overrides standard Symfony bundle configurations.

Customizing the platform

Learn how to customize your own forumify here.

If you created something you think others may benefit from, and you would like to share your customizations, you can move your customization to a plugin and publish it on packagist and promote it on the forumify marketplace.

Contributing

When you believe you've found a bug or think the platform could be expanded with a new feature. You can start by creating an issue here on GitHub.

The easiest way to contribute to forumify is by using the production template and installing the platform with composer using a symlink.

Add the following to the template's composer.json:

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

Now when you run composer install, the platform will be symlinked and any changes you do will immediatly be available in your project.

Code quality

The following checks are performed when you create a pull request:

• Tests: PHPUnit
• CodeStyle: checked by PHPCS, using the PSR-12 codestyle
• Static analysis: checked by PHPStan

You can avoid failing builds by running these tools locally:

On Linux/WSL/MacOS:

• Quality checks: make quality
• Tests: make tests

On Windows:

• See commands in Makefile and execute manually.