README.md

Configuration

These environment variables should be set acodingly

DB_DATABASE=planning_poker
DB_USERNAME=root
DB_PASSWORD=

PUSHER_APP_ID=
PUSHER_APP_KEY=
PUSHER_APP_SECRET=
PUSHER_HOST=127.0.0.1
PUSHER_PORT=6001
PUSHER_SCHEME=http

MAIL_MAILER=

Setup

Install dependencies

cp .env.example .env

composer install

npm install

Build the assets

npm run build

generate an encryption key

php artisan key:generate

Start app

if you have valet installed, what i recommend

valet link

or run

php artisan serve

Services

If you want to use the mail verification feature make sure to start a mailpit

docker run -d --restart unless-stopped --name=mailpit -p 8025:8025 -p 1025:1025 axllent/mailpit

For the websocket server you can either choose a pusher js or a replacement SAAS solution.

If you want to use the open source laravel websocket which is installed run

php artisan websocket:serve

Code style and quality

formats the code

npx prettier --write .

in order to test only use

npx prettier --check .

static code check

php vendor/bin/phpstan

Run tests

php artisan test

run PHP code quality checks

php artisan insights -n

run PHP code style check

php vendor/bin/pint --test

in order to autofix run

php vendor/bin/pint

pre commit hook

install captainhook via

php ./vendor/bin/captainhook install -f

License

The Planning Poker App is under the MIT license.