Welcome to strichlistensystem 👋

Tally system for the first week of the Department of Electrical Engineering and Information Technology at FH Aachen - University of Applied Sciences.

main

dev

Install

Clone the repository and install the dependencies:

git clone git@github.com:fsr5-fhaachen/strichlistensystem.git
cd strichlistensystem
npm install
composer install

Copy .env.example to .env and fill in the database credentials.

cp .env.example .env

Generate the application key:

php artisan key:generate

Run the migrations:

php artisan migrate

Usage

development

For development, you can use the built-in PHP server:

php artisan serve

and the vite dev server:

npm run dev

devcontainer

If you want to use the provided devcontainer via laravel sail you need vscode and the devcontainer extension.

testing

You can run the tests with:

vendor/bin/phpunit

build

You can build the application with:

npm run build

production

This project uses laravel octane with roadrunner as production server. You can install the server with: This step will also ask you to download the roadrunner binary.

php artisan octane:install

You can run the production server with: Define the worker-count and max-requests to fit your needs.

php artisan octane:start --max-requests=512 --workers=4

docker

If you want to use docker, use the following commands:

docker build -t ghcr.io/fsr5-fhaachen/strichlistensystem:latest .
docker-compose up -d
docker exec -it strichlistensystem-web php artisan migrate:fresh --seed

Authors

👤 Titus Kirch (main author)

• Website: https://tkirch.dev/
• LinkedIn: Titus Kirch
• Twitter: @TitusKirch
• GitHub: @TitusKirch

👤 Benedikt Haas (main author)

• LinkedIn: Benedikt Haas
• Github: @BenediktHaas96

👤 Simon Ostendorf

• LinkedIn: Simon Ostendorf
• GitHub: @simonostendorf

👤 Till Voss

• GitHub: @TiltedPhosphor

Show here to see the full list of contributors who participated in this project.

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2022 fsr5-fhaachen.
This project is MIT licensed.