heptacom/heptaconnect-package-web-frontend

HEPTAconnect Package for Web Frontend

1.0.2 2024-01-05 14:10 UTC

Requires

• php: >=8.0
• ext-filter: *
• ext-json: *
• ext-mbstring: *
• bentools/iterable-functions: >=1.4 <2
• heptacom/heptaconnect-dataset-base: ^0.9.0
• heptacom/heptaconnect-portal-base: ^0.9.6
• psr/http-factory: ^1.0
• psr/http-message: ^1.0 || ^2.0
• psr/http-server-handler: ^1.0
• psr/http-server-middleware: ^1.0
• psr/simple-cache: ^1.0
• symfony/config: ^5.0 || ^6.0
• symfony/dependency-injection: ^5.0 || ^6.0
• symfony/error-handler: ^5.0 || ^6.0
• twig/string-extra: ^3.0
• twig/twig: ^3.0

Requires (Dev)

• infection/infection: >=0.21
• phpunit/phpunit: >=9.3 <10

Suggests

• ext-fileinfo: If available, assets will get automatic mime types assigned
• ext-zend opcache: If available op cache will be cleared
• twig/intl-extra: Is a nice package for formatting and i18n. If you require it, it will be loaded automatically. Excluded as it requires symfony/intl which is a big dependency

Conflicts

• nikic/php-parser: 4.7.0

AGPL-3.0-or-later, proprietary

• HEPTACOM GmbH

• twig
• admin-ui
• bootstrap5
• heptaconnect
• heptaconnect-package

README

This is part of HEPTACOM solutions for medium and large enterprises.

Description

This is a HEPTAconnect package to build web frontends for portals and integrations. Read more in the documentation.

Features

Twig

Build web page using Twig templates. Twig provides a basic infrastructure for replacements and extensibility by portals, extensions and other packages.

Bootstrap

A basic page structure is provided with a topbar, sidebar, main content area and notifications. The page is built using Bootstrap. It supports automatic and manual dark mode.

Themes

Packages can provide custom assets, templates and influence each other to allow full customization to build your own web page.

Access protection

All paths handled using the UiHandlerContract are protected by default. You can make exceptions and make publicly available pages. Logins can be achieved using different provided functionalities: one time login, htpasswd-alike user storage, custom authentication backends.

More

• Cookie based browser sessions
• Notification
• Error handling
• Debugging

Configurable Feature Separation

A lot of features can be configured and disabled to ensure you can build your application instead of adapting yourself to the application. Read more about the configuration in our documentation.

System requirements

• PHP 8.0 or above

Changelog

See the attached CHANGELOG.md file for a complete version history and release notes.

Additional development requirements

• Make
• Any debugging/coverage php extension like xdebug or pcov

Contributing

Thank you for considering contributing to this package! Be sure to sign the CLA after creating the pull request.

Steps to contribute

1. Fork the repository
2. git clone yourname/heptaconnect-package-web-frontend
3. Make your changes to master branch
4. Create your Pull-Request

Check your changes

1. Check and fix code style make cs-fix && make cs
2. Check tests make test
3. Check whether test code coverage is same or higher make coverage
4. Check whether tests can find future obscurities make infection

License

Copyright 2020 HEPTACOM GmbH

Dual licensed under the GNU Affero General Public License v3.0 (the "License") and proprietary license; you may not use this project except in compliance with the License. You may obtain a copy of the AGPL License at https://spdx.org/licenses/AGPL-3.0-or-later.html. Contact us on our website for further information about proprietary usage.