Align README and workflows for Pohodex repo

This commit is contained in:
2026-05-11 09:59:48 +02:00
parent 786cbc724f
commit 03faa33936
6 changed files with 16 additions and 114 deletions
+13 -83
View File
@@ -1,102 +1,32 @@
# Pohodex Event Manager
<div style="text-align: center;">
<a href="https://github.com/BuildWithHussain/event_manager/actions/workflows/ci.yml"><img src="https://github.com/BuildWithHussain/event_manager/actions/workflows/ci.yml/badge.svg?branch=main" alt="CI"></a>
<a href="https://github.com/BuildWithHussain/event_manager/actions/workflows/ui-tests.yml"><img src="https://github.com/BuildWithHussain/event_manager/actions/workflows/ui-tests.yml/badge.svg?branch=main" alt="UI Tests"></a>
<a href="https://github.com/BuildWithHussain/event_manager/stargazers"><img src="https://img.shields.io/github/stars/BuildWithHussain/event_manager?style=social" alt="GitHub stars"></a>
<a href="https://www.gnu.org/licenses/agpl-3.0"><img src="https://img.shields.io/badge/License-AGPL_v3-blue.svg" alt="License: AGPL v3"></a>
<a href="https://github.com/BuildWithHussain/event_manager/commits/main"><img src="https://img.shields.io/github/commit-activity/m/BuildWithHussain/event_manager" alt="GitHub commit activity"></a>
</div>
Frappe aplikace pro správu kulturních akcí, vstupenek a check-in procesu.
![Pohodex Event Manager Event DocType](.github/images/fe-event-main-form.png)
## Stav projektu
Open Source, Powerful, and Comprehensive Event Management Platform
Repo je založené jako fork/reference z původního projektu a je přebrandované pro Pohodex.
V dalších krocích budeme postupně odebírat nepotřebné části a nechat jen funkce relevantní pro náš use-case.
### Learn & Connect
[Telegram Public Group](https://t.me/bwh_buzz)
### Stack / Architecture
1. Frappe Framework: The Backend and Admin Interface
2. FrappeUI (based on Vue & TailwindCSS): For the frontend dashboard (for attendee, sponsors, etc.)
3. Frappe Builder: For the public pages like events list and details page.
### The Main Entity
The **Pohodex Event Manager Event** DocType/Form is the primary entity of the system. Once you have created an event, you can setup ticket types, sponsorship tiers, add-ons (like T-Shirts, Meals, etc.), schedule, and much more!
### Features
This is not an exhaustive list by any means, just to give you an idea 😃
#### Dynamic Ticket & Add-on Types
![Dynamic Ticket Types and Add-ons](.github/images/ticket-types-and-add-ons.png)
#### The Booking Form
Once you have defined the proper ticket types, add-ons, and publish your event, the booking form will dynamically use it for booking.
![Booking Form](.github/images/booking-form.png)
#### Payments App Integration
This app depends on Frappe's Payments app for online payments. You can select a Payment Gateway in the event form. BTW GST collection is just a check-box away 😉
#### The Dashboard
![Booking Details Page](.github/images/booking-details-page.png)
#### Ticket Management
The benefits of having a "self-service" dashboard for attendees is that they can modify their bookings on their own (the deadlines can be configured from the **Pohodex Event Manager Settings**). For example, changing their T-Shirt Size after booking:
![Change Add-on Preference](.github/images/ticket-updates.png)
They can also transfer tickets or request for cancellation.
#### Sponsorship Management
Folks can enquire about sponsoring an event and upon approval from the event management team (from desk), they can directly pay from the dashboard too:
![Sponsorship Payment](.github/images/sponsorship-payment.png)
*As soon as they pay, their logo appears on the event page!*
![Sponsorship Management](.github/images/sponsorship-management.png)
### Installation
You can install this app using the [bench](https://github.com/frappe/bench) CLI:
## Instalace (Bench)
```bash
cd $PATH_TO_YOUR_BENCH
bench get-app BuildWithHussain/event_manager --branch main
bench install-app event_manager
bench get-app https://git.hilled.cz/pohodex-team/event-manager.git
bench --site <site-name> install-app event_manager
```
### Contributing
This app uses `pre-commit` for code formatting and linting. Please [install pre-commit](https://pre-commit.com/#installation) and enable it for this repository:
## Vývoj
```bash
cd apps/event_manager
pre-commit install
```
Pre-commit is configured to use the following tools for checking and formatting your code:
## CI/CD
- ruff
- eslint
- prettier
- pyupgrade
### CI
Workflow soubory v `.github/workflows` jsou ponechané jako výchozí šablona a momentálně jsou nastavené jen pro ruční spuštění (`workflow_dispatch`), aby se na tomto repu nespouštěly automaticky nevalidní pipeline.
This app can use GitHub Actions for CI. The following workflows are configured:
## Licence
- CI: Installs this app and runs unit tests on every push to `develop` branch.
- Linters: Runs [Frappe Semgrep Rules](https://github.com/frappe/semgrep-rules) and [pip-audit](https://pypi.org/project/pip-audit/) on every pull request.
### License
agpl-3.0
AGPL-3.0