PHPackages                             heptaconnect/production - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. heptaconnect/production

ActiveProject

heptaconnect/production
=======================

2153PHP

Since Jul 13Pushed 1y ago3 watchersCompare

[ Source](https://github.com/HEPTACOM/heptaconnect-production)[ Packagist](https://packagist.org/packages/heptaconnect/production)[ RSS](/packages/heptaconnect-production/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

HEPTAconnect
============

[](#heptaconnect)

> Repository template for production integration

This repository is intended to be forked and modified to your individual use case. It provides a quickstart for projects aiming for a standalone application based on HEPTAconnect. [You can learn more about HEPTAconnect in the documentation.](https://heptaconnect.io/guides/integrator/)

Installation
------------

[](#installation)

1. Fork this repository. Clone your fork to your local machine and navigate to the repository on your command line interface.
2. Run `composer install`.
3. Run `bin/console system:setup` to generate your `.env` file. The wizard will prompt you for database credentials.
4. Run `bin/console system:install`.
5. Configure the document root directory (`/public`) to be hosted by a webserver under a dedicated hostname.
    1. If you are using macOS, we recommend [Laravel Valet](https://laravel.com/docs/9.x/valet).
6. Run `bin/console heptaconnect:config:base-url:set ` where you replace `` with the previously configured hostname.

✅ That's it. The system installation is complete.

Development
-----------

[](#development)

- You can install additional portals or portal extensions via composer.
    - Run `composer require niemand-online/heptaconnect-portal-amiibo`.
    - Run `bin/console heptaconnect:portal-node:add 'NiemandOnline\HeptaConnect\Portal\Amiibo\AmiiboPortal' amiibo`
- You can develop custom portals or portal extensions by adding them in the directory `/src/Portal`.
    - Create a new directory `/src/Portal/HelloWorld`.
    - Inside this new directory create a class `HeptaConnect\Production\Portal\HelloWorld\HelloWorldPortal` that extends `Heptacom\HeptaConnect\Portal\Base\Portal\Contract\PortalContract`.
    - Run `bin/console cache:clear`.
    - Run `bin/console heptaconnect:portal-node:add 'HeptaConnect\Production\Portal\HelloWorld\HelloWorldPortal' hello-world`.
    - [Read more about portal development in the documentation.](https://heptaconnect.io/guides/portal-developer/)
- You can create migrations to get reproducible database operations that run once per installation.
    - Run `bin/console database:create-migration` to generate a new migration file in `/src/Integration/Migration`.
    - The `\HeptaConnect\Production\Integration\Component\Migration\MigrationHelper` class provides convenience methods like `addPortalNode`, `addRoute` and `activatePortalExtension`.
    - You can use `\Heptacom\HeptaConnect\Storage\Base\Bridge\Contract\StorageFacadeInterface` via `$migrationHelper->getStorageFacade()`. This will grant you access to every storage action of the management storage.
    - You can use `\Doctrine\DBAL\Connection` via `$migrationHelper->getConnection()`. This will grant you direct access to the underlying database.
    - Run `bin/console system:update:finish` to apply all new migrations.
- You can normalize your code-style using `laravel/pint`.
    - Edit `pint.json` to customize your defined rules.
        - [Here is an overview of all available rules and their configuration options.](https://mlocati.github.io/php-cs-fixer-configurator/)
    - Run `composer cs:lint` to check your code against your defined rules.
    - Run `composer cs:fix` to automatically apply your defined rules to your code.

Deployment
----------

[](#deployment)

Your deployment strategy will influence the availability of your application and the amount of maintenance required during deployments. Since any good deployment strategy is tailored to your specific requirements and circumstances, there is no universal solution. So, instead of providing a complete deployment script, we provide a narrative of recommended steps.

- It is recommended to use some kind of CI/CD pipeline for your deployments. Some of the best known providers are:
    - [GitHub Actions](https://github.com/features/actions)
    - [GitLab CI/CD pipelines](https://docs.gitlab.com/ee/ci/pipelines/)
    - [Bitbucket Pipelines](https://bitbucket.org/product/features/pipelines)
- Run `composer install --no-dev` in your CI/CD pipeline.
    - Collect the files you want to deploy in an artifact.
- Stop all running cronjobs and message consumers on your target server(s).
    - If you are using [Supervisor](http://supervisord.org/), run `supervisorctl stop all`.
    - If you are using [Cron](https://de.wikipedia.org/wiki/Cron), run `crontab -r`.
- Copy your prepared artifact files to your target server(s).
- Also remember to delete files on your target server(s) that have been removed or renamed since your last deployment.
    - If you are using [rsync](https://rsync.samba.org/), use the option `--delete`.
    - ⚠️ Caution: Only apply deletions in the directories `/src` and `/vendor`! Other directories contain files that are custom for their environment and not part of your VCS.
- Run `bin/console cache:clear` on your target server(s) to clear the cache.
- Run `bin/console system:update:finish` on your target server(s) to apply database migrations.
- Finally, start your cronjobs and message consumers again.

###  Health Score

18

—

LowBetter than 8% of packages

Maintenance27

Infrequent updates — may be unmaintained

Popularity11

Limited adoption so far

Community14

Small or concentrated contributor base

Maturity18

Early-stage or recently created project

 Bus Factor1

Top contributor holds 90.9% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/da7c96557362be36f81cdf8ced7beffe281982bb1adb75a3d836e65bf289286c?d=identicon)[heptacom](/maintainers/heptacom)

---

Top Contributors

[![jkrzefski](https://avatars.githubusercontent.com/u/11394739?v=4)](https://github.com/jkrzefski "jkrzefski (30 commits)")[![JoshuaBehrens](https://avatars.githubusercontent.com/u/1133593?v=4)](https://github.com/JoshuaBehrens "JoshuaBehrens (2 commits)")[![leonrustmeier](https://avatars.githubusercontent.com/u/23141241?v=4)](https://github.com/leonrustmeier "leonrustmeier (1 commits)")

---

Tags

composer-projecthacktoberfestheptaconnecttemplate-project

### Embed Badge

![Health badge](/badges/heptaconnect-production/health.svg)

```
[![Health](https://phpackages.com/badges/heptaconnect-production/health.svg)](https://phpackages.com/packages/heptaconnect-production)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
