From 03faa33936520d336e4d298816ee235d8a0b64f9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jakub=20Kopeck=C3=BD?= Date: Mon, 11 May 2026 09:59:48 +0200 Subject: [PATCH] Align README and workflows for Pohodex repo --- .github/workflows/ci.yml | 5 +- .github/workflows/linter.yml | 7 -- .github/workflows/pr-tittle-check.yml | 7 +- .github/workflows/typecheck.yml | 11 +-- .github/workflows/ui-tests.yml | 4 -- README.md | 96 ++++----------------------- 6 files changed, 16 insertions(+), 114 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index f970288..9b54102 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -1,10 +1,7 @@ name: CI on: - push: - branches: - - main - pull_request: + workflow_dispatch: concurrency: group: main-event_manager-${{ github.event.number }} diff --git a/.github/workflows/linter.yml b/.github/workflows/linter.yml index 8e93d3b..56ce270 100644 --- a/.github/workflows/linter.yml +++ b/.github/workflows/linter.yml @@ -1,15 +1,8 @@ name: Linters on: - push: - branches: - - main - pull_request: workflow_dispatch: -permissions: - contents: read - concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true diff --git a/.github/workflows/pr-tittle-check.yml b/.github/workflows/pr-tittle-check.yml index c0648fb..b05bfa0 100644 --- a/.github/workflows/pr-tittle-check.yml +++ b/.github/workflows/pr-tittle-check.yml @@ -1,12 +1,7 @@ name: PR Title Check on: - pull_request: - types: - - opened - - reopened - - synchronize - - edited + workflow_dispatch: permissions: pull-requests: write diff --git a/.github/workflows/typecheck.yml b/.github/workflows/typecheck.yml index c987bfb..922d7c5 100644 --- a/.github/workflows/typecheck.yml +++ b/.github/workflows/typecheck.yml @@ -1,16 +1,7 @@ name: Dashboard TypeScript on: - push: - branches: - - develop - paths: - - "dashboard/**" - - ".github/workflows/typecheck.yml" - pull_request: - paths: - - "dashboard/**" - - ".github/workflows/typecheck.yml" + workflow_dispatch: concurrency: group: typecheck-event_manager-${{ github.event.number || github.sha }} diff --git a/.github/workflows/ui-tests.yml b/.github/workflows/ui-tests.yml index f1d8085..7a9004e 100644 --- a/.github/workflows/ui-tests.yml +++ b/.github/workflows/ui-tests.yml @@ -1,10 +1,6 @@ name: UI Tests on: - push: - branches: - - main - pull_request: workflow_dispatch: concurrency: diff --git a/README.md b/README.md index 3c2e944..7f92923 100644 --- a/README.md +++ b/README.md @@ -1,102 +1,32 @@ +# Pohodex Event Manager -
- CI - UI Tests - GitHub stars - License: AGPL v3 - GitHub commit activity -
+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 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