https://github.com/carsso/kantine
Kantine - Web interface displaying Kantine menus
https://github.com/carsso/kantine
Last synced: 15 days ago
JSON representation
Kantine - Web interface displaying Kantine menus
- Host: GitHub
- URL: https://github.com/carsso/kantine
- Owner: carsso
- License: mit
- Created: 2023-08-08T03:06:22.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-07T09:54:03.000Z (19 days ago)
- Last Synced: 2025-04-11T04:43:02.141Z (15 days ago)
- Language: PHP
- Homepage: https://kantine.menu
- Size: 606 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](LICENSE)
# Kantine
Web interface displaying Kantine menus.
Written in PHP/Laravel and VueJS.
### Screenshots:
#### Live preview
[Kantine.menu](https://kantine.menu)
#### Menu view
## Pre-requisites
- PHP >= 8.3
- NodeJS >= 23
- FontAwesome Pro 6 license, with a [configured .npmrc file](https://docs.fontawesome.com/web/setup/packages#project-specific-using-configuration-files)
## Deployment
#### Clone repository
```sh
git clone https://github.com/carsso/kantine.git
```
#### Copy default env file
```sh
cp .env.example .env
```
#### Fill the env file
```sh
vim .env
```
#### Install JS dependencies based on lock file
```sh
npm install
```
#### Build assets
```sh
npm run build
```
#### Install PHP dependencies based on lock file
```sh
composer install --no-interaction --prefer-dist --optimize-autoloader
```
#### Init Python virtual env
```sh
python3 -m venv scripts/
scripts/bin/pip3 install -r scripts/requirements.txt -U
scripts/bin/python3
```
#### Clear cache
```sh
php artisan optimize
```
#### Create the storage symbolic links
```sh
php artisan storage:link
```
#### Run queue worker
```sh
php artisan queue:listen
```
#### Run reverb server
```sh
php artisan reverb:start
```
## Development
#### Clone repository (main branch)
```sh
git clone [email protected]:carsso/kantine.git
```
Install PHP dependencies with Composer
```sh
composer install
```
Install JS dependencies with NPM
```sh
npm install
```
#### Copy default env file
```sh
cp .env.dev.example .env
```
#### Fill the env file
```sh
vim .env
```
#### Create the storage symbolic links
```sh
php artisan storage:link
```
#### Init Python virtual env
```sh
python3 -m venv scripts/
scripts/bin/pip3 install -r scripts/requirements.txt -U
scripts/bin/python3
```
#### Build js and css files automatically while developing
```sh
npm run dev
```
#### Run queue worker
```sh
php artisan queue:listen
```
#### Run reverb server
```sh
php artisan reverb:start
```
## License
- This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
- The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).