Readme

README.md

@@ -1,3 +1,44 @@
-# OpenWeddingApp
+# 💒 OpenWedding
 
-An open source wedding app for Android
+An open source wedding suite for Android.
+
+## 📱 Android app
+
+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.
+
+![App](images/screenshot_app_1.png)
+![App](images/screenshot_app_2.png)
+![App](images/screenshot_app_3.png)
+
+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)
+- 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.
+- Tableau de mariage: every guest can see in the app to which table is assigned
+- Other informative sections, like Location (with map and button to open the navigation app), lunch menu, wedding gift/lists... These static sections can be updated remotely without needint the user to update the app.
+
+## 📷 Photo booth
+
+In `photo-booth` folder.
+
+A webpage to implement a photo boot that automatically posts any taken photo to the social feed in the app.
+I run it on a selfbuilt totem containing a laptop, monitor and speakers.
+
+![Photo booth](images/photobooth_1.jpg)
+![Photo booth](images/photobooth_2.jpg)
+
+
+## 📽️ Web feed
+
+In `web-feed` folder.
+
+A simple webpage showing the same social feed from the app on a browser. Used to show on a projected screen the photos taken by the guests in real time during the event.
+
+## 🖥️ Web Services
+
+In `services` folder.
+
+The web services required to make the app, the photo booth and the web feed work.
+They run on a LAMP stack.