Filler game

Implementation of a turn-based strategic computer game Filler for two players on the Laravel framework.

Overview

• app/Services/Filler - Contains the main game logic files
• app/Models - Contains all the Eloquent models
• app/Http/Controllers/GameController.php - Contains the main game controller
• database/migrations - Contains all the database migrations
• routes - Contains all api routes defined in api.php file and web routes in web.php file containing entry point for ui
• tests - Contains all the application feature tests in Feature/GameTest.php file and unit tests in Unit/FieldTest.php

Installation

Please check the official laravel installation guide for server requirements before you start.

Clone the repository

git clone https://github.com/chamexxxx/filler.git

Switch to the repo folder

cd filler

Install all the dependencies using composer

composer install

Copy the example env file and make the required configuration changes in the .env file

cp .env.example .env

Generate a new application key

php artisan key:generate

Run the database migrations (Set the database connection in .env before migrating)

php artisan migrate

Start the local development server

php artisan serve

You can now access the server at http://localhost:8000 The api can be accessed at http://localhost:8000/api.

TL;DR command list

git clone https://github.com/chamexxxx/filler.git
cd filler
composer install
cp .env.example .env
php artisan key:generate
php artisan migrate
php artisan serve

Make sure you set the correct database connection information in the .env file before running the migrations

Testing

You may use the test Artisan command to run tests

php artisan test

More details: Laravel Testing

Docker

To run with Docker follow these instructions:

Configure a Bash alias that allows you to execute Sail's commands

alias sail='bash vendor/bin/sail'

Create and start containers

sail up

Run the database migrations

sail artisan migrate

More details: Laravel Sail