Resonate - An Open Source Social Voice Platform

This project is divided into two repositories:

1. Resonate Flutter App
2. Resonate Backend (You are here)

Go to this repository to know more about the project.

Environment Setup :

1. Pre-requisites :

   (a) Fork the Repo

   (b) Clone the Repo : git clone https://github.com/AOSSIE-Org/Resonate-Backend

2. Follow this guide to obtain your HOST, API-KEY, API-SECRET from livekit-cloud.

3. Create a new project on Appwrite Cloud or self host it locally by pulling their docker image. Know more about Appwrite here.

Functions :

Here's a list of the functions available in the Resonate Backend:

1. create-room: Creates a new room, interacting with Appwrite and Livekit. Generates an access token for the admin.

   • Source Code

2. database-cleaner: Cleans up old data in the participants, active pairs, and OTP collections using Appwrite.

   • Source Code

3. delete-room: Deletes a room from both Appwrite and Livekit, including associated participant records. Ensures only the room admin can delete the room.

   • Source Code

4. join-room: Generates a Livekit access token for a user to join a specified room.

   • Source Code

5. livekit-webhook: Handles webhooks from Livekit. Specifically, it validates the webhook event and, if a room_finished event is received, it deletes the corresponding room from Appwrite.

   • Source Code

6. match-maker: Matches random user requests based on language and anonymity, creating active pairs and deleting the matched requests. This function is triggered by an Appwrite event when a new request document is created.

   • Source Code

7. send-otp: Generates a 6-digit OTP, sends it to the recipient's email via a mail service, and stores the OTP with its creation date in Appwrite.

   • Source Code

8. send-story-notification: Sends push notifications to followers of a user when a new story is created, using Firebase Cloud Messaging (FCM) and Appwrite to retrieve follower tokens.

   • Source Code

9. start-friend-call: Sends a Firebase Cloud Messaging (FCM) data message to a specific recipient's FCM token, likely to initiate a call.

   • Source Code

10. sync-all-documents-with-meilisearch: Synchronizes all story and user documents from Appwrite databases to Meilisearch indexes in chunks.

    • Source Code

11. sync-stories-with-meilisearch: Synchronizes individual story documents to Meilisearch based on Appwrite document events (create, update, delete).

    • Source Code

12. sync-users-with-meilisearch: Synchronizes individual user documents to Meilisearch based on Appwrite document events (create, update, delete).

    • Source Code

13. upcomingRoom-isTime-checker: Checks upcoming rooms and updates their isTime status to true if the scheduled time is within a 5-minute window (before or after), using Appwrite to manage room data. (Note: Notification sending functionality is commented out.)

    • Source Code

14. upcomingRoom-Message-Notification: Sends notifications to subscribers and the creator of an upcoming room, using Firebase Cloud Messaging (FCM) and Appwrite to retrieve tokens.

    • Source Code

15. verify-email: Updates the email verification status of a user in Appwrite to true for a given user ID.

    • Source Code

16. verify-otp: Verifies a user-provided OTP against a stored OTP in Appwrite and records the verification status.

    • Source Code

Communication Channels

If you have any questions, need clarifications, or want to discuss ideas, feel free to reach out through the following channels:

• Discord Server
• Email

We appreciate your contributions and look forward to working with you to make this project even better!