Rally championship manager

Let this web application manage the boring stuff of your rally championship, keeping track of results and points for each rally and stage, so you can be focused on achieving the best TEMPO!!

🔴 Online version!

A live version is available here

Table of contents

• 🔧 Starting from scratch
• 🔧 Setting up a local istance
• 🐳 Setting up a Docker container
• 📊 [Optional] Setting up testing

🔧 Setting up a local istance

System requirements

• PHP 7.3+
• Composer
• node.js
• npm

Additional requirements

• Php driver for the kind of database you want to use. Something like php-mysql for mysql, php-sqlite3 for sqlite or php-pgsql for PostgreSQL
• php-xml
• php-mbstring

Steps:

• Clone this repository
• Run composer install to insall all the php dependencies
• Run npm install && npm run dev && npm run dev to install the js dependencies to use bootstrap
• Rename the .env.example file in .env
• Run php artisan key:generate to generate a key the application will use
• Make sure you have a database to store the data of the application, and fill the needed info in the .env file or as environment variables
• Run php artisan migrate to start a database migration
• Run php artisan serve to launch the web server

🐳 Setting up a Docker container

System requirements

• Docker

Steps:

• Clone this repository
• Rename the .env.example file in .evn
• Make sure you have a database to store the data of the application, and fill the needed info in the .env file or as environment variables
• Run ./vendor/bin/sail up to start the docker containers

📊 [Optional] Setting up testing

Some basic tests have already been implemented, but there is no thing like too much testing, so some additions would be welcome. You can do so by running php artisan make:test [-u] <subfolder/testName>

Before starting, you may want to create a testing database with mkdir -p database && touch database/database.sqlite and change these settings in the phpunit.xml file:

<server name="DB_CONNECTION" value="sqlite"/>
<server name="DB_DATABASE" value="database/database.sqlite"/>

I'd suggest using a different database from the one you use to store data, since a testing session will wipe every previous entry in the database, and this might not be what you want.

To actually start the tests, run php artisan test

Credits

• The Laravel framework is open-sourced software licensed under the MIT license.
• Bootswatch (Darkly) for the css styling