/Tools

A collection of more or less useful Tools/Management software written with Laravel

Primary LanguagePHPMIT LicenseMIT

Welcome to BlubberLounge Tools 🔧

A collection of more or less useful management software written by the BlubberLounge Team ❤️‍🔥

⚙️ Features

  • User/Player management
  • Acces Request system
  • Auditing (+ logging)
  • Dart (game) management system
  • Dart statistics
  • Live Dart view
  • Dart lobby management
  • Notification system
  • Device management
  • Battery simulation
  • User feedback system
  • FAQ
  • Api (+ OpenApi/Swagger Documentation)

💭 Future ideas

  • TBD: fill with Future Ideas

Screenshots

👪 Contributing

If you plan to submit a PR bigger than a simple change in one file, here is a short intro about how to do a clean PR. greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project locally via git clone https://github.com/BlubberLounge/Tools.git (replacing BlubberLounge with your GitHub Username) and work on your local copy
  2. Add the upstream repository via git remote add upstream https://github.com/BlubberLounge/Tools.git
  3. Ensure you are on the master branch via git checkout master
  4. Create your Feature Branch by running git checkout -b <temp_branch>
  5. Set the upstream branch via git push --set-upstream origin <temp_branch>
  6. Work on your local and push as many commits as you want

When you think it is ready to merge and submit a PR:

  1. Return to the master branch via git checkout master
  2. Ensure your master branch is up-to-date with the latest changes via git pull upstream master
  3. Update your fork of this repo by running git push
  4. Create a new branch to be used for your PR via git checkout -b <pr_branch>
  5. Set the upstream branch via git push --set-upstream origin <pr_branch>
  6. Merge the edits but be sure to remove the history of your local commits via git merge --squash <temp_branch>
  7. Create a new commit containing all of your merged changes via git commit -m "<Message>"
Now you have a clean single commit from which you can create the PR on the WLED Github.

How to install (for development)

  1. Clone this repo

    git clone https://github.com/BlubberLounge/Dart-WebApp.git Dart-WebApp

  2. Install all dependencies

    composer install && npm install

  3. Copy .env.example, Paste and Rename to .env. Create Database conenction. Configure as needed.

    Default DB config
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=dart_webapp
DB_USERNAME=root
DB_PASSWORD=

  4. Database migration

    php artisan migrate

  5. ( Start the Development Server )

    php artisan serve

📝 Notes

Testing 🧪

Run tests sequentially with artisan

php artisan test
php artisan test --profile
php artisan test --coverage

OR

php artisan test --testsuite=Feature
php artisan test --testsuite=Unit
php artisan test --testsuite=Feature --stop-on-failure

Run tests in Parallel with artisan

php artisan test --parallel
php artisan test --parallel --processes=4

php artisan test --parallel --testsuite=Feature --processes=4

Laravel 10.x Testing Documentation

✌️ Other

Licensed under the MIT license.