🏆 PDRNL Events Registration

About

A centralized competition registration platform where all drone racing pilots can register for competitions.

Development - Get started

Click to expand!

Requirements

• Docker (and docker-compose v2.x)
• Composer
• Nginx proxy manager (optional)

You can start developing in 2 ways:

Devcontainers

1. Clone the repository
2. Reopen in container
3. When the container build is finished: bash init.sh

Docker

How to start with this Laravel Docker template:

1. Clone the repository
2. Create a .env file and make an symbolic link

cp ./laravel/.env.example ./laravel/.env
ln -s laravel/.env .env

3. Inside the .env file give the following variables a value

   • APP_NAME
   • DOCKER_IMAGE_NAME
   • DB_HOST
   • DB_DATABASE
   • DB_USERNAME
   • DB_PASSWORD
   • DB_ROOT_PASSWORD

4. Change the port numbers according to your situation

   • DB_PORT
   • HOST_HTTP_PORT
   • HOST_HTTPS_PORT

NOTE: if you are going to use your Laravel environment in combination with a domain name and SSL, change the APP_ENV to production.

5. Install the composer packages and generate a key

cd laravel && composer install && php artisan key:generate && cd ..

6. Create an symbolic link to for the storage folder

cd laracel && php artisan storage:link && cd ..

Run

When you have done the getting started part, it's time to start the docker containers.

docker compose up -d --build

After this only do a Laravel migration to the database and you are ready!

cd laravel && php artisan migrate

Tools

Create storage symlink

When you create a symlink according to the laravel command (php artisan storage:link) it will create a static link and cause problems in the docker container. It's best to run the following command to get the same result:

cd public && ln -s ../storage/app/public storage

Create a backup

To make a backup of the application, run the command below.

php artisan backup:run

Run tests

Run the migrations to the test sqlite database. You may have to create a database.sqlite file before running the migrations.

php artisan migrate:fresh --env=testing

Test the application.

php artisan test

Contributing

Would you like to contribute to the development of this project? Then read the prepared contribution guidelines and go ahead!

Thank you for being involved! 😍

License

MIT License

Copyright (c) 2021-2023 Klaas Schoute

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.