Challenge Overview
Project Overview
System Description
This project, the CSFV Community Gaming website project will provide the web site infrastructure and integration of the games. This will be a web site that is available on the Internet, and also will be delivered in a form where the server and the games can be installed and used behind a firewall.
The goal of this architecture challenge is to build an auditing and tracking module to track user (player) actions in the CSFV websites/applications, and build custom reports to view in logaholic that enable view reports filtered by user ids.
This module provides the following:
- Provide statistics that are going to be used by CSFV owner to decide future product direction.
- Provide statistics that are going to be used by the CSFV owner for marketing reasons
The module mainly uses the Logaholic to track the user actions/visits, and provide various reports.Additional, there are a few user activities are tracked programmatically from the CSFV application. These activities are recorded in the same database as the other Logaholic tables, in order to ease the report generation.
Competition Task Overview
A complete list of deliverables can be found in the TopCoder Assembly competition Tutorial at:
Note: Please read the whole Application Design Specification first. All the details not mentioned in this specification are provided in that document.
Updates of the Logaholic to Track Bizuser and Method
The TCUML class diagram for “Updates of the Logaholic to Track Bizuser and Method” depicted all the necessary changes for the Logaholic routines to track the bizuser and the HTTP method.
The updates are based on Logaholic 4.1.8.
The Logaholic table changes are applied in the Logaholic routines for auto-creating the Logaholic tables.
For the Logaholic profile that is already installed, where the tables are already generated, a separate DDL is provided for referencing. See the architecture documents.
Logaholic Custom Reports
The TCUML class diagram for “Logaholic Custom Reports” depicted all the new classes determined
All the custom report classes will be placed in the /<logaholic-root>/reports/<ClassName>.php files.
See the ADS configuration section for all the new texts defined in the interface.php in /<logaholic-root>/languages/english/.
CSFV Updates
The TCUML class diagram for “CSFV Updates” depicted all the new classes determined.
A new tracking_util.js, connection_holder.js, and activity_util.js should be added to both CSFV Frontend Module and the CSFV Mini-Site Frontend Module.
app.js, Login.js of both applications should be updated.
Github Rep
The URL of the CSFV Github Repo is:
Final Submission Guidelines
Submission
- Source code
- Deployment guide to configure and verify the application.
Deployment
The Logaholic can be deployed in any web server that supports PHP extension, including Nginx and Apache.
The Node.JS follow the existing deployment approach.
The application connects to the MySQL database system.
Technology overview
- Node.js
- PHP
- Logaholic
- MySQL
Existing Documents
- Class Diagrams
- Sequence Diagrams
- Application Design Specification
- Assembly Specifications
- ERD