This repository contains the source code for the official HBO-ICT IT-Conference.
Since the application uses Docker, the development environment must be in Linux for optimal performance and compatibility with Laravel Sail; either use native Linux or use WSL. Installing a Linux distribution also will be needed - the most used one during the development process was Ubuntu, but it is still a personal preference. NPM/Node should also be present on the distro as of this version.
Since Laravel Sail takes on most of the configuration and installation of the project, the following steps need to be taken in order to install.
- Clone the repository (https://github.com/HZ-HBO-ICT/it-conference.git) onto your local machine (on the WSL)
- Open PHPStorm (or the editor of choice) in remote development in the WSL and find the folder
- Run in the root folder of the project
docker run --rm \
-u "$(id -u):$(id -g)" \
-v "$(pwd):/var/www/html" \
-w /var/www/html \
laravelsail/php84-composer:latest \
composer install --ignore-platform-reqsWe highly recommend adding an alias for the ./vendor/bin/sail command. Check the wiki or read further down in the README on how to do that.
- Set up the environment variables -
cp .env.example .env - After the dependencies are installed run
./vendor/bin/sail up -d - Install the NPM packages -
./vendor/bin/sail npm install - Add the app key -
./vendor/bin/sail artisan key:generate - After the creation of the containers run
./vendor/bin/sail artisan migrate - Run
./vendor/bin/sail npm run devor./vendor/bin/sail npm run buildto either start a dev server or to create a build.
- Incorrectly set permissions
This issue may be encountered after installing the application and trying to access it through the browser. It can be something along the lines of:
The stream or file "/var/www/html/storage/logs/laravel.log" could not be opened in append mode: Failed to open stream: Permission denied
In order to fix this run chmod -R 777 storage bootstrap/cache. This issue might even occur when the artisan commands are used via sail. If that occurs, try granting only the permissions only to the specified directories.
- Setting an alias
Instead of using every time ./vendor/bin/sail this can be shorten by using an alias - alias sail='[ -f sail ] && sh sail || sh vendor/bin/sail'. This way the commands will shorten (e.g. sail up -d)
The application supports a couple of "stages". We created a specific function to ensure that the seeded data is as close as possible to the actual data at each stage. You can use it by running: sail artisan db:setup [stage]. The stage parameter allows for the following values: initial, company-registration, participant-registration.
Note: The most important tests we have are also running as GitHub Actions. Opening a PR or making new commits to it will trigger a workflow when you push your code to the repository, which will run the tests automatically.
If you run the test normally you can use: sail phpunit.
If you want to run your tests a bit faster you can run them in parallel you can use: sail artisan test --parallel
Keep in mind that in the GitHub actions workflow is running using the parallel testing which might cause some conflicting results if you run the local tests "normally" (e.g. actions fails while tests pass locally).
If you want to check if your code passes the coding standards you can use: sail run vendor/bin/phpcs.
Some of the sniffs can be fixed automatically - to fix those you can use: sail run vendor/bin/phpcbf
If you want to check if your code passes the PHPStan conventions you can use: sail run /vendor/bin/phpstan analyse --configuration=phpstan.neon
If you have made changes on any model you can generate the new documentation using: sail run artisan ide-helper:models -RW
When the decision has been made to deploy the application to a server, the instructions can be found here.
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
We use the following format for versioning: YYYY.R.B
YYYY is the year of the release, so 2025.
R represents the release within a year, so if it is the first it would be 1, if it is the second it would be 2.
B represents bugfixes.
- Tim Kardol - Conference Organiser - TimKardol
- Valeria Stamenova - Conference Website Project Lead - v-stamenova
- Ihor Novikov - Conference Senior Developer - IGORnvk
- Silvia Popova - Conference Design Specialist - popo0015
- Gijs Borghouts - Fullstack Developer - CaptainPancakeWithBacon
- Gabriella Khayutin - Frontend Developer - GabriellaKhayutin1
- Nikol Alexandrova - Frontend Developer -NikolAlexandrova
- Erik van den Broek - Backend Developer - erjbroek
- Alisiia Mishchenko - Fullstack Developer - alisiia02
See also the list of contributors who participated in this project.
The code in this repository is licenced MIT. All creative works (photos and videos) on the website itself are copyrighted by HBO-ICT unless otherwise stated. Please contact us at tim.kardol@hz.nl if you would like to use our work.