nicklas/comment

Anax comment module.

1.0.8 2017-10-24 13:40 UTC

This package is not auto-updated.

Last update: 2020-01-10 16:39:09 UTC


README

Build Status CircleCI Scrutinizer Code Quality Code Coverage Build Status SensioLabsInsight Gitter

Comment Module for Anax

This is a comment module for the Anax framework. This README.md assumes you have a decent knowledge of the Anax-framework.

Why use this module?

Well, maybe you are a front-end developer who's building an anax app and can't really bother with the backend stuff. Well this is prebuilt for you, so you can style the default views and use data from modules to create new ideas and pages with the data.

We've added some jquery in the views, so you can get some Ajax in the questions views, but it's optional to use.

What does it contain?

  1. Login System (users,admins)
  2. Questions and Answers System.
  3. Comment System
  4. Prebuilt HTMLForms

Setup

Let's get started. You can use composer to install the package, then we will integrate the module with your Anax.

Install with composer

composer require nicklas/comment

Router files

  1. Copy the config/route/comment catalog and paste it in your own Anax installation.
  2. Copy code in the config/route.php and paste it in your own config/route.php.

DI-container

Copy everything that lies in the config/di.php and paste it in your own DI-container. Also make sure that you add any dependency that you might not added already.

Also don't be surprised that we're adding a renderpage class, since this module uses it's own renderpage functions, therefore we need to add them in our DI.

Database

Use the SQL-code in the src/Comment/sql/setup.sql to setup your database.

You'll need a config/database.php file. In other words, you'll need a normal setup for anax\database. If you already have a file, then you can use that one.

Views

In /views you'll find the views for the module. You can copy them and paste it in own Anax installation. Then you can style them for your own website.

PageRender

I recommend that you copy the src/page into your own and that to the commentFrontController in your DI, so you have better control of this part.

Add more?

You can use use class() if you want to make your own Pagerenders with the modules.

License

This software carries a MIT license.

 .  
..:  Copyright (c) 2017 Nicklas Envall (Nicklas766@live.se)