2.1 KiB
PsalmTafel
Developed by Robin (and Rudi) Schanbacher
Warning
This project is currently in active development. Please do not use it in production environments yet.
Overview
Purpose
PsalmTafel is a real-time display system designed for choirs. It enables the choir director to select and switch songs seamlessly via a web application or app. A tablet, TV, or any browser-capable device then displays the active song number, songbook, and title to the choir members.
Key Features
- Real-time Synchronization: The display automatically updates within 5 seconds whenever a song is changed.
- Fully Responsive: Optimised for tablets, smartphones, desktop browsers, and Smart TVs.
- Multi-Songbook Support: Easily manage and switch between multiple songbooks concurrently.
- Dark & Light Mode Support: Modern, clean UI built for clear readability in any lighting condition.
Installation & Setup
For detailed installation guides and deployment instructions, please visit our Wiki:
Contributing
We welcome contributions of all kinds! Please take a moment to review the guidelines below before getting started.
Important
Language Policy: While the user interface (UI) is primarily in German, all code, comments, variables, documentation, and issue descriptions must be written in English to keep the project accessible to international contributors.
How to Contribute
-
Reporting Issues:
- Before creating a new issue, please check existing issues to avoid duplicates.
- Use clear titles and provide detailed descriptions (including steps to reproduce bugs).
-
Submitting Pull Requests (PRs):
- Fork or branch off the main repository (e.g.,
feat/my-new-featureorfix/issue-description). - Keep your commits clean using Conventional Commits (e.g.,
feat:,fix:,style:,refactor:). - Open a Draft Pull Request early if you want feedback on work-in-progress code.
- Fork or branch off the main repository (e.g.,
License
This project is licensed under the GPL-3.0 License.