README

This is a re-usable component for logging and exposing activity streams for Joomlatools Framework.

Activities API

The component includes an API for working with activities. This API fully adheres to and extends the Activity Streams specification v1.0. JSON activity streams provided by the component are also fully compliant with the standard.

Requirements

Joomlatools Framework 3
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-activities:3.*

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 activities in a database table named activities. 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.

Authors

See the list of contributors.

License

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

Community

Keep track of development and community news.

Follow @joomlatoolsdev on Twitter
Join joomlatools/dev on Gitter
Read the Joomlatools Developer Blog
Subscribe to the Joomlatools Developer Newsletter

joomlatools / framework-activities

Maintainers

Details