Skip to content

pr0-dev/pr0verter

Repository files navigation

pr0verter




pr0verter! Video converter for pr0gramm.com
LIVE URL: dev.pr0verter.de

Dependencies:

Installation

As a Laravel application pr0verter comes with Laravel Sail development environment, that does mean for development and testing you can ignore mentioned required software and just use the Docker based Laravel Sail environment instead. This does require Docker to be installed on your system! It is highly advised that you read the Documentation for Laravel Sail.

Install dependencies

Since Laravel Sail is being installed using Composer it is required that you do install all dependencies before using Laravel Sail to run the development environment. Since Laravel Sail does require Docker to be installed we can use an intermediade container to do so as described in the documentation on how to install dependencies for existing projects - this will install all dependencies using Composer and NPM.

docker run --rm \
    -u "$(id -u):$(id -g)" \
    -v $(pwd):/var/www/html \
    -w /var/www/html \
    laravelsail/php81-composer:latest \
    composer install --ignore-platform-reqs

As all dependencies have been installed using Composer you can start the Laravel Sail development environment using the sail up command.

Once the environment has successfully bootet up you can continue to install and build dependnecies using NPM. You can do this using the following commands:

sail npm install \
&& sail npm run dev

Configure

On the first time running the project you will have to create your own .env configuration file. This file will not be commited and is only available locally. To create it, you can simply create an empty file or copy .env.example.

It is required that you do set your application key, this can be generated using the following command:

sail artisan key:generate

Database

Once the dependnecies are installed and the application has been configured you can proceed to migrate the database schema. To do so simply run the following command:

sail artisan migrate

Production

To run this application in production you can orient yourself at the Laravel Sail Dockerfile and other files in the /docker directory for a list of required software and configuration. It is advised that you completely read the Laravel Documentation. Keep in mind that Laravel Sail is NOT meant to be used in production.