Skip to content

Latest commit

 

History

History
69 lines (47 loc) · 1.91 KB

README.md

File metadata and controls

69 lines (47 loc) · 1.91 KB
Raw

About Game Tracker

Game Tracker can be used to track and rank players in any two-player game with scores. It was initially developed to track foosball player rankings.

Requirements

The application is written in PHP, using the Laravel framework, and a PostgreSQL database. The following requirements are needed:

  • PHP 7.0+
  • OpenSSL PHP Extension
  • PDO PHP Extension
  • Mbstring PHP Extension
  • Tokenizer PHP Extension
  • PostgreSQL 9.5+

The instructions below assume that you are using the Homestead development environment (tested using version 5.5), however this should work in most environments as long as the requirements above are met.

Installation Instructions

Clone the project and enter the project directory

git clone https://github.com/JellyRollMorton/game-tracker.git
cd game-tracker

Install PHP dependencies via Composer

composer install

Initialize the configuration/environment file. If you are not using Homestead, you will also want to update the .env file to provide the credentials of your PostgreSQL database. You can also choose to update the APP_NAME variable, which changes the title of the application within the UI.

cp .env.example .env

Generate the Laravel application key

php artisan key:generate

Create all database objects

php artisan migrate

By defaut, there is no user and user registration is disabled. You will need to create a new user via the tinker interface.

php artisan tinker

Enter in the following code at the tinker prompt to create a user:

$user = new App\User();
$user->name = 'My Name';
$user->password = Hash::make('insert password here');
$user->email = '[email protected]';
$user->save();

Exit tinker (Ctrl+C)

The application should now be accessible via the site name that was defined when Homestead was configured, or via your web server URL.