README.md

Kantine

Web interface displaying Kantine menus.

Written in PHP/Laravel and VueJS.

Screenshots:

Live preview

Kantine.menu

Menu view

Pre-requisites

• PHP >= 8.1
• NodeJS >= 18
• FontAwesome Pro 6 license, with a configured .npmrc file

Deployment

Clone repository

git clone https://github.com/carsso/kantine.git

Copy default env file

cp .env.example .env

Fill the env file

vim .env

Install JS dependencies based on lock file

npm install

Build assets

npm run build

Install PHP dependencies based on lock file

composer install --no-interaction --prefer-dist --optimize-autoloader

Init Python virtual env

python3 -m venv scripts/
scripts/bin/pip3 install -r scripts/requirements.txt
scripts/bin/python3

Clear cache

php artisan optimize

Create the storage symbolic links

php artisan storage:link

Run queue worker

php artisan queue:listen

Development

Clone repository (main branch)

git clone [email protected]:carsso/kantine.git

Install PHP dependencies with Composer

composer install

Install JS dependencies with NPM

npm install

Copy default env file

cp .env.dev.example .env

Fill the env file

vim .env

Create the storage symbolic links

php artisan storage:link

Init Python virtual env

python3 -m venv scripts/
scripts/bin/pip3 install -r scripts/requirements.txt
scripts/bin/python3

Build js and css files automatically while developing

npm run dev

Run queue worker

php artisan queue:listen

License

• This project is licensed under the MIT License - see the LICENSE file for details.
• The Laravel framework is open-sourced software licensed under the MIT license.