heig-PDG/mono

Check our project out on YouTube !

An Android and web application to match and meet people based on meals, recipes and tupperwares. This is a semester project done at HEIG-VD.

More information is available on the class repository on GitLab.

Team

Name
Matthieu Burguburu	[email protected]
David Dupraz	[email protected]
Alexandre Piveteau	[email protected]
Guy-Laurent Subri	[email protected]

Structure

We use a mono-repository approach to store and manage the files of our project. We also make use of some external tools for prototyping.

The sub-folder structure is as follows:

• .github/ contains GitHub-specific files, such as issue templates, and the workflows that run whenever we make changes to the app;
• docker contains our different docker images, and our Docker-related scripts;
• spec/ contains our OpenAPI spec,
• src/ contains the source code of our application;
• vcs contains some scripts related to our VCS;
• website/ contains our landing page; amd
• wiki/ contains our reference branding as well as details over our collaboration process.

Our prototypes are visible on Figma (overview, live prototype).

Local Setup

Warning: In order to run the backend locally, some setup will need to be done. As it is quite cumbersome, we highly recommend that you would use the live version, which is available on api.tupperdate.me. The Android application is available here.

Environment variables

To build the backend, you will need to setup a Firebase project and have the following environment variables set up:

• Your Google Service Account: GOOGLE_SERVICE_ACCOUNT;
• GOOGLE_DATABASE_NAME, which is the link to your google firebase database;
• And your GOOGLE_BUCKET_NAME, which should also be given to you by the Firebase Console.

To build the application, you will need to sign the app. You will also need to provide your own src/mobile/google-services.json.