Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/patrickrobrecht/flexible-event-and-booking-manager
Flexible Event Bookings made with Laravel 10
https://github.com/patrickrobrecht/flexible-event-and-booking-manager
Last synced: 10 days ago
JSON representation
Flexible Event Bookings made with Laravel 10
- Host: GitHub
- URL: https://github.com/patrickrobrecht/flexible-event-and-booking-manager
- Owner: patrickrobrecht
- Created: 2022-11-13T18:39:48.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-03T14:02:04.000Z (about 1 month ago)
- Last Synced: 2024-10-10T02:22:02.586Z (28 days ago)
- Language: PHP
- Homepage:
- Size: 878 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Flexible Event and Booking Manager
[](https://github.com/patrickrobrecht/flexible-event-and-booking-manager/actions/workflows/code-style.yml)
[](https://github.com/patrickrobrecht/flexible-event-and-booking-manager/actions/workflows/tests.yml)
This application allows to manage events, their booking forms and bookings via a web-based platform.
## Features
- Manage events and event series, locations, and organizations
- Events and series can have a parent event (series).
- Manage booking options and their booking forms (for events without a parent event)
- Users editing booking forms can see a preview for the booking forms if bookings are not enabled yet.
- Bookings
- Confirmation via email
- Guest bookings are supported, but can be forbidden by enabling the restriction to logged-in users in the settings of the booking option.
- Users with the corresponding access rights can view, export, edit, delete and restore bookings.
They can also add a booking comment and set the payment status.
- Group participants for events with bookings
- Bookings are automatically grouped by their booking option.
- If a date of birth is submitted, the age of each participant and average age of each group is shown.
- Sub events have the bookings from parent event.
- Generate groups (randomized or age-based)
- Manage responsibilities (responsible users with their position) for events, event series and organizations
- Add, update, delete documents for events, event series, and organizations
- Login and logout, reset password, verify e-mail address, edit own account
- Manage users and flexible roles
- Notify users if an account was created for them (optional)
- Registration (if enabled via `.env`)
- Manage personal access tokens (for [Laravel Sanctum](https://laravel.com/docs/10.x/sanctum))
- Footer links for legal notice, privacy, terms and conditions configurable via `.env`
## Development
### Requirements
To get started, you need to install the following software:
- [Composer](https://getcomposer.org/) to manage PHP dependencies,
- [PHP](https://www.php.net/), and the PDO extension for the database of your choice,
- a relational database, such as [MariaDB](https://mariadb.org/download/)
### Used technologies
- [Alpine.js](https://alpinejs.dev/) to extend Livewire with some additional JavaScript
- [Bladestrap](https://github.com/portavice/bladestrap), Blade components for Bootstrap
- [Bootstrap](https://getbootstrap.com/), a front-end toolkit
- [Font Awesome](https://github.com/FortAwesome/Font-Awesome) for [icons](https://fontawesome.com/icons?d=gallery&m=free)
- [Laravel](https://laravel.com/docs/10.x) framework
- [Laravel Dompdf](https://github.com/barryvdh/laravel-dompdf) for PDF export
- [Laravel Livewire](https://livewire.laravel.com/docs/) for dynamic UI without leading PHP
- [Laravel Query Builder](https://spatie.be/docs/laravel-query-builder/v5/introduction) for custom filtering and sorting
- [PhpSpreadsheet](https://phpspreadsheet.readthedocs.io/en/latest/) for Excel exports
- [Laravel Sluggable](https://github.com/spatie/laravel-sluggable) to autogenerate slugs
### How to develop
To setup/update your development environment:
- Run `composer install` to setup autoloading and install the development dependencies for PHP.
- Create/update the `.env` configuration if necessary (see [Configuration](#configuration) below).
- Run `php artisan migrate` to migrate the database to the latest version.
For development, we use
- [ESlint](https://eslint.org/) for the JavaScript code style check
- [Laravel Debugbar](https://github.com/barryvdh/laravel-debugbar) for debugging utility
- [Laravel Mix](https://laravel-mix.com/docs/) for compiling assets
- [Laravel Pint](https://laravel.com/docs/10.x/pint) for the PHP code style check.
- [Laravel Translatable String Exporter](https://github.com/kkomelin/laravel-translatable-string-exporter)
- [Stylelint](https://stylelint.io/) for the SASS code style check
### Code Style
Run `composer cs` to check compliance with the code style
and `composer csfix` to fix code style violations before every commit
(see composer.json` and `package.json` for commands to run the code style check/fix for just one language).
- PHP code MUST follow the [Pint configuration](./pint.json), including [PSR-12 specification](https://www.php-fig.org/psr/psr-12/).
- Laravel code SHOULD follow the best practices from the list
[by Alexey Mezenin](https://github.com/alexeymezenin/laravel-best-practices).
- JavaScript code MUST follow [the default ESLint rules](https://eslint.org/docs/rules/).
- CSS code MUST follow [the standard stylelint rules](https://stylelint.io/user-guide/rules).
Any texts in the code MUST be in English.
Use `composer translate` to extract them to `lang/de.json`.
### How to deploy
- Run `composer production` to remove development dependencies.
- Create/update the `.env` configuration if necessary.
- Run `php artisan migrate` to migrate the database to the latest version.
- Upload files to the production system.
## Configuration
- `APP_NAME` and `APP_OWNER` define name and owner shown in header or footer.
- `APP_DEFAULT_LOCALE` defines the locale to use for translations by default.
- `APP_URL_LEGAL_NOTICE`, `APP_URL_PRIVACY_STATEMENT`, and `APP_URL_TERMS_AND_CONDITIONS` can be set to URLs
for the respective pages which show up in the footer of the webpages and of the emails.
- `REGISTRATION_ENABLED=true` enables registration which is disabled by default.