Skip to content

Latest commit

 

History

History
47 lines (29 loc) · 1.93 KB

README.md

File metadata and controls

47 lines (29 loc) · 1.93 KB

Comments Component for Joomlatools Framework

This is a re-usable component for implementing basic commenting functionality for Joomlatools Framework.

Requirements

  • Joomlatools Framework 2 or newer
  • PHP 5.3 or newer
  • MySQL 5

Installation

Install using Composer. Go to the root directory of your Joomla installation in command line and execute this command:

composer require joomlatools/framework-comments:2.*

The component will be installed in the vendor folder of the root directory of your Joomla site. The framework will make sure that the component is bootstrapped from that location and made available to other components extending it or just making use of it.

Out of the box, the component will attempt to store comments in a database table named comments. An SQL dump file may be found under the /resources/install directory for creating this database table. This database needs to be manually created for the component to function properly. At the moment we only support MySQL.

Contributing

This component is an open source, community-driven project. Contributions are welcome from everyone.We have contributing guidelines to help you get started.

Contributors

See the list of contributors.

License

Comments Component for Joomlatools Framework is free and open-source software licensed under the GPLv3 license.

Community

Keep track of development and community news.