Issue tracking application extending GitHub's issues and pull requests for the Joomla! project.
Clone or download
Permalink
Failed to load latest commit information.
.github Issue/PR templates Feb 17, 2016
.openshift Use the "use_composer" marker Jul 24, 2015
Documentation Update depfile Jul 29, 2018
assets Allow valign-center on td Aug 7, 2018
bin Create a symlink to `tracker.php` with alias `jtracker` in `bin` Feb 2, 2014
build Remove PHPCS as submodule Jun 24, 2018
cache Add a /cache/.gitignore file Jun 23, 2013
cli Set allowed fails to 0 Oct 2, 2018
etc Remove Transifex code Jun 17, 2018
logs Remove log Nov 30, 2014
src Similar checks for other models Oct 11, 2018
templates index page table a11y Aug 6, 2018
tests tests & cs Jul 20, 2017
www Revert "Change check" Oct 1, 2018
.gitignore Move assets to NPM and Webpack via Laravel Mix to remove Bower from b… Jun 23, 2018
.npmrc Set required Node/NPM versions, strict engine for project Jul 22, 2018
.php_cs Add a few more fixers consistent with existing style structures Jul 23, 2016
.travis.yml Use Trusty on Travis Sep 10, 2017
LICENSE License file Feb 25, 2017
README.md Update docs to remove Bower references Jul 29, 2018
Vagrantfile Update PHP package source Sep 18, 2017
build.xml Update docs to remove Bower references Jul 29, 2018
composer.json Vendor update Jul 29, 2018
composer.lock Update coding standards Oct 2, 2018
credits.json Transifex removed Jul 10, 2016
package-lock.json Drop Bower and Grunt Jun 24, 2018
package.json Set required Node/NPM versions, strict engine for project Jul 22, 2018
phpunit.xml Clean up the unit test command a bit, update test environment Mar 25, 2016
ruleset.xml Migrate to PHPCS 2.x ruleset, fix most issues, mark allowed fails due… Jun 24, 2018
webpack.mix.js Manually build load-image to put it in the right order Jun 24, 2018

README.md

Requirements Build Status Scrutinizer Code Quality Crowdin

The issue tracker application requires a server running:

  • PHP 7.0 or later
    • PHP's ext/curl and ext/intl should also be installed
  • MySQL 5.5.3 with InnoDB support (required to support the MySQL utf8mb4 charset)

The application also has external dependencies installable via Composer and NPM.

See also: Dependencies.

Note: All references to bin/jtracker refer to an executable symlink to cli/tracker.php. If you cannot execute the bin/jtracker symlink replace that path with cli/tracker.php

Setup

  1. Clone the git repo to where ever your test environment is located or download a ZIP file.
    • Note If you plan to contribute to the project, you might have to use git clone --recursive to get the submodules checked out.
  2. Copy etc/config.dist.json to etc/config.json.
  3. In the etc/config.json file, enter your database credentials and other information.
  4. Run composer install (or the equivalent for your system) to install dependencies from Composer.
  5. From a command prompt, run the install command to set up your database.
    • bin/jtracker install

If you are making a change to the issue tracker's web assets, you'll also need to set up NPM. Please see the Asset Management documentation for more information.

Verify the installation is successful by doing the following:

  1. View the site in your browser.
  2. Run the get project command to pull issues, issue comments and other information related to the project from GitHub.
    • bin/jtracker get project

See also: CLI script.

Virtual Test Environment

As an alternative method, there is a setup for a virtual test environment using Vagrant and VirtualBox.

See also: Virtual server documentation

Using Login with GitHub

If you want the 'Login with GitHub' button to work properly you'll need to register an app with GitHub. To do this manage your account at github.com and go to the applications page. Create a new application.

You'll be asked for the application URL and the callback URL. This can be your test server or your localhost environment. As long as you enter the URL that your localhost app is running on. An example might be http://jissues.local.

Once you've registered the app at GitHub you'll receive a Client ID and a Client Secret, enter these into your installation's etc/config.json file, along with your GitHub login credentials. You should now be able to login with GitHub successfully.

See also: GitHub Authentication

Support & Discussion