Routes Project

Project, which by given two endpoints, A and B, returns the shortest path between them (composed of multiple direct roads), the minutes needed to travel that road, and the information about the filling stations, fuels along the way.

See the Laravel Readme in /docs/README.md

Requirements

XAMPP - PHP version 8, MariaDB - 10.4.x, Apache - 2.4.x, composer 2.1.x

How To Run

Clone the project and cd into its directory.
From .env.example create .env.
Start MySQL/MariaDB server and create the routes-database (should be with the same name as the DB_DATABASE environment variable - in .env).
Run the following commands php artisan key:generate, composer install, npm install.
Migrate the database php artisan migrate with and seed with php artisan db:seed
Start the application with php artisan serve.

Deployment Strategy

Deployment is done with Docker and Heroku.

The Dockerfile in project root and /scripts/deployment-script.sh are used for that matter.

SendGrid

The application has email sending functionality (in the Contact Us page - /contacts/create).

To use it, you should create a Single Sender, then obtain an API Key from https://sendgrid.com and then save it in the .env configuration file, alongside other needed information.

# example SendGrid configuration
SENDGRID_EMAIL=<your.email@example.com>
SENDGRID_NAME=<your.name>
SENDGRID_API_KEY=<your.sendgrid.api.key>

Gmail Setup

Besides SendGrid, we use Gmail to send the tokens for password resetting.

You will need to configure the following .env variables and enable less secure applications (https://myaccount.google.com/security) for that functionality to work.

Feel free to use your own mail provider and its specific settings.

MAIL_MAILER=<smtp||your.setting.here>
MAIL_HOST=<smtp.gmail.com||your.setting.here>
MAIL_PORT=<465||your.setting.here>
MAIL_USERNAME=<your.sender_username>
MAIL_PASSWORD=<your.sender_password>
MAIL_ENCRYPTION=<ssl||your.setting.here>
MAIL_FROM_ADDRESS=<your.sender_email>
MAIL_FROM_NAME="${APP_NAME}"