Update README.md

This commit is contained in:
2026-01-31 22:04:17 +01:00
parent 67d672fcab
commit 9e65ccf4e8

View File

@@ -6,14 +6,14 @@ An open source wedding suite for Android.
In `android-app` folder. In `android-app` folder.
The guests are provided of an invite in the form of a qrcode that can be used both to download the app and to log in the app. They download the Android app that serves as an invite and guide to the event, as well as basic "socal network" where the photos shoot by the guests are published. The guests are provided of an invite in the form of a qrcode that can be used both to download the app and to log in the app. They download the Android app that serves as an invite and guide to the event, as well as basic "social network" where the photos shoot by the guests are published.
![App](images/screenshot_app_1.png) ![App](images/screenshot_app_1.png)
![App](images/screenshot_app_2.png) ![App](images/screenshot_app_2.png)
![App](images/screenshot_app_3.png) ![App](images/screenshot_app_3.png)
Features: Features:
- Social: contains the photos shot by the guests and the bride and groom. The bride and groom can publish photos in any moment, while the guests can publish only during the event (see `photoSharingEnabled` in services/www/static/settings.json) - Social: contains the photos shot by the guests and the bride and groom. The bride and groom can publish photos in any moment, while the guests can publish only during the event (see `photoSharingEnabled` in `services/www/static/settings.json`)
- Invite: the guests can reply to the invite telling if they will be present and if they have any food intolerance. - Invite: the guests can reply to the invite telling if they will be present and if they have any food intolerance.
- Event places: an interactive map of the event location with markers and descriptions of the various activities (aperitif, lunch, games and events), along with the timespan in wich they will be available. - Event places: an interactive map of the event location with markers and descriptions of the various activities (aperitif, lunch, games and events), along with the timespan in wich they will be available.
- Tableau de mariage: every guest can see in the app to which table is assigned - Tableau de mariage: every guest can see in the app to which table is assigned
@@ -42,3 +42,20 @@ In `services` folder.
The web services required to make the app, the photo booth and the web feed work. The web services required to make the app, the photo booth and the web feed work.
They run on a LAMP stack. They run on a LAMP stack.
# Contributions
## Why isn't this hosted on GitHub?
I'm using a private git server just because I'm worried for the vast majority of open source code being hosted in a server property of Microsoft and being used to train theirs AI.
I didn't find a better option, BTW the Gitea project is working on implementing federation, so soon it will be possible to contribute using any other gitea server, selfhosted or not.
## How to contribute
The project is open to contribution, but with some limits:
- I'm sorry I can't accept AI-generated contributions. Reviewing a contribution requires time and effort from my side, while generating code with AI requires very little time and produces non reliable code that must be reviewed in detail. This is effectively shifting the work on my side, and in a forced way. If you feel you need a feature but you're not able to implement it by yourself, I prefer you to create an issue in the repository so I can implement it when I can, in a more mantainable way.
- I prefer to make project-wide changes (i.e. updating Android target, app name and icon, release number...) by myself.
To contribute, you'll have to create an account on this git instance. Unfortunately, I had to disable registration to avoid huge waves of fake accounts created by bots.
You can request an account writing to daniele.verducci@ichibi.eu