HLState/README.md

65 lines
1.8 KiB
Markdown
Raw Normal View History

2024-01-05 22:44:12 +02:00
# HLState
2024-01-07 00:27:17 +02:00
2024-01-12 20:35:45 +02:00
Web Monitor for Half-Life based on [Xash3D FWGS](https://github.com/FWGS/xash3d-fwgs) masters crawler
2024-01-07 00:27:17 +02:00
2024-01-07 00:29:18 +02:00
![HLState](https://github.com/YGGverse/HLState/assets/108541346/e8559edf-8429-496e-afbb-752a822cd3d6)
2024-01-07 00:27:17 +02:00
## Install
2024-01-07 02:43:29 +02:00
* `apt install git composer curl php php-xml php-intl php-mbstring php-curl php-sqlite3`
2024-01-07 00:27:17 +02:00
* `git clone https://github.com/YGGverse/HLState.git`
* `cd HLState`
* `composer install`
2024-01-07 18:24:48 +02:00
* `php bin/console doctrine:migrations:migrate`
2024-01-07 00:27:17 +02:00
### Setup
2024-01-07 02:46:04 +02:00
* `chown -R www-data:www-data var`
2024-01-07 00:27:17 +02:00
* `cp .env .env.local`
2024-01-07 18:14:09 +02:00
* `crontab -e` > `* * * * * /usr/bin/curl --silent http://localhost/crontab/index &> /dev/null`
2024-01-07 00:27:17 +02:00
## Update
2024-01-07 04:28:12 +02:00
* `git pull`
2024-01-07 04:21:00 +02:00
* `git merge`
2024-01-07 00:27:17 +02:00
* `composer update`
* `php bin/console doctrine:migrations:migrate`
2024-01-07 02:43:29 +02:00
* `APP_ENV=prod APP_DEBUG=0 php bin/console cache:clear`
2024-01-07 00:27:17 +02:00
2024-01-07 04:23:34 +02:00
## Contribution
Please create new branch from main before make PR
* `git checkout main`
* `git checkout -b 'new-commit-branch'`
2024-01-07 00:27:17 +02:00
## License
* Engine sources [MIT License](https://github.com/YGGverse/HLState/blob/main/LICENSE)
## Versioning
[Semantic Versioning 2.0.0](https://semver.org/#semantic-versioning-200)
## Components
* [Symfony Framework](https://symfony.com)
* [SVG icons](https://icons.getbootstrap.com)
* [PHP Source Query](https://github.com/xPaw/PHP-Source-Query)
2024-01-12 20:35:45 +02:00
* [HL-PHP](https://github.com/YGGverse/hl-php)
2024-01-07 04:14:41 +02:00
* [Half-Life logo](https://commons.wikimedia.org/wiki/File:Half-Life_lambda_logo.svg)
2024-01-11 01:17:33 +02:00
* [Favicons](https://realfavicongenerator.net)
2024-01-07 00:27:17 +02:00
## Support
* [Issues](https://github.com/YGGverse/HLState/issues)
## Blog
* [Mastodon](https://mastodon.social/@YGGverse)
## See also
2024-01-07 00:28:38 +02:00
* [half-life-server](https://github.com/YGGverse/half-life-server) - Half-Life server edition by YGGverse
2024-01-07 00:29:18 +02:00
* [pymaster](https://github.com/YGGverse/pymaster) - Refactored master server written in Python