README

Basically, this is still the version 0.1.4, although there are many improvements have been made.

How to install

The installation of the OJStat is still similar to the previous versions.

Get the app

First, of course, get the app. OJStat zip can be downloaded from its official GitHub page and then download the dependencies using composer. But as for now, the app can be downloaded using Composer:

composer create-project languaojs/ojstat ojstat

This command creates the folder ojstat and download the app into that folder. I recommend you to test the app in the localhost first. If you are using a previous version of OJStat, please backup your OJStat file and database before upgrading to this version. If you are testing using localhost (e.g., XAMPP or WAMP), please make an empty database and provide the credentials in the OJStat configuration file. If you are downloading the zip, make sure that you run the following command after extracting it:

composer install

Configuration

The configuration file is located in config/Config.php. In this file, you will need to adapt the values of the following variables:

APP_EDIT: This variable is by default true, assuming that you are using localhost. However, when uploading to your OJS folder, you must set this variable to false so that it can use the correct server database configuration.
OJSTAT_SETUP: This variable is by default false. This must be set to true so that you can run the setup (install or upgrade). After the installation or upgrading processes completed, you must set this variable to false.
LOCAL_URL: This is when you are testing or configuring using localhost. The value is like localhost/ojstat, without http:// or https://.
BASE_URL: This is for the real base or location of your OJStat folder, which must be in the root folder of your OJS. For instance, if your OJS URL is https://myjournal.edu, the BASE_URL must be myjournal.edu/ojstat.
Database configuration: This should be self-explanatory. The variables like DB_HOST is for hostname (typically localhost), DB_USER is for database username, DB_PASS is for the password, and DB_NAME is the database name. If the APP_EDIT is true, the app will use LOCAL_ (e.g., LOCAL_DB_HOST). Meanwhile, when it is set to false, it will use DB_ (e.g., DB_HOST).

Site Information

This is also self-explanatory. The information like SITE_NAME (e.g., University name), PLACE_NAME, SITE_ADDRESS, etc. will appear in the footer of the app. So, please adjust.

Email config

OJStat this version does not send or receive emails. So, this part does not need any change. The variables by default are provided by ViperPHP, the framework used to build this OJStat.

Installation and Upgrade

When the variable OJSTAT_SETUP is set to true, accessing OJStat (e.g., localhost/ojstat) will give you the setup page. From there, follow the guide step by step. After installing or upgrading, set the variable value to false.

Journals and users information

This version of OJStat requires you to update the following:

Journal cover
User's profile photo It is so because starting from this version, OJStat will store the journal covers and users' profile photos in its directory. This is done to help you maintain the media, in case you move to a new host or when the old host is unavailable.

OJStat link and widgets

You will need to replace your OJStat link (script tag) and widget codes in your OJS by generating new link and codes using this new version. In this version, OJStat no longer uses iframe for widgets. Also, you can choose whether to use widgets or not. Saying this, there are two script tags.

OJStat main script

This script tag is to link your OJS journal with OJStat, which is obligatory.

OJStat widget script

This script tag is to render widgets in your OJS journal sidebar, which is optional. When this script is used, please place the script tag under the OJStat main script tag.

languaojs / ojstat

Maintainers

Details