Skip to content

Latest commit

 

History

History
126 lines (87 loc) · 5.72 KB

README.md

File metadata and controls

126 lines (87 loc) · 5.72 KB
Raw

HZ University of Applied Sciences

Contributors PHPCS Build MIT License

IT-Conference Website

This repository contains the source code for the official HBO-ICT IT-Conference.

Environment Setup

Prerequisites

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.

Configuration and Installation

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.

  1. Clone the repository (https://github.com/HZ-HBO-ICT/it-conference.git) onto your local machine (on the WSL)
  2. Open PHPStorm (or the editor of choice) in remote development in the WSL and find the folder
  3. 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/php83-composer:latest \
    composer install --ignore-platform-reqs
  1. Install the NPM packages - npm install
  2. Set up the environment variables - cp .env.example .env
  3. After the dependencies are installed run ./vendor/bin/sail up -d
  4. Add the app key - ./vendor/bin/sail artisan key:generate
  5. After the creation of the containers run ./vendor/bin/sail artisan migrate
  6. Run npm run dev

Possible complications

  • 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)

Running the tests

GitHub Actions will trigger a workflow when you push your code to the repository, which will run the tests automatically.

On a local machine, you may run ./vendor/bin/sail phpunit. If you get a large amount of errors, check whether the application key has been set successfully, and that either npm run build or npm run dev have been run.

Deployment

When the decision has been made to deploy the application to a server, the instructions can be found here.

Built With

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use the following format for versioning: YYYY.R.B

YYYY is the year of the release, so 2024.

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.

Current Team

  • Tim Kardol - Conference Website Project lead - TimKardol
  • Valeria Stamenova - Conference Senior Developer - v-stamenova
  • Ihor Novikov - Conference Senior Developer - IGORnvk
  • Silvia Popova - Conference Website Developer - popo0015
  • Simeon Atanasov - Conference Website Developer - g0sh06

See also the list of contributors who participated in this project.

License

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 [email protected] if you would like to use our work.