Skip to content

Commit 6769371

Browse files
author
Punitkumar756
committed
feat: update README with new functions for Meilisearch synchronization and room management
1 parent 795f29b commit 6769371

1 file changed

Lines changed: 49 additions & 2 deletions

File tree

README.md

Lines changed: 49 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,41 @@ Go to [this repository](https://github.com/AOSSIE-Org/Resonate) to know more abo
1919

2020
3. Create a new project on [Appwrite Cloud](https://appwrite.io/) or self host it locally by pulling their [docker image](https://appwrite.io/docs/self-hosting). Know more about Appwrite [here](https://appwrite.io/docs).
2121

22+
## Project Structure :
23+
24+
```
25+
Resonate-Backend/
26+
├── appwrite.json # Appwrite configuration file
27+
├── Caddyfile # Caddy server configuration
28+
├── README.md # Project documentation
29+
├── init-auth.ps1 # PowerShell authentication initialization script
30+
├── init-auth.sh # Bash authentication initialization script
31+
├── init.ps1 # PowerShell initialization script
32+
├── init.sh # Bash initialization script
33+
└── functions/ # Serverless functions directory
34+
├── create-room/ # Room creation function
35+
├── database-cleaner/ # Database cleanup function
36+
├── delete-room/ # Room deletion function
37+
├── join-room/ # Room joining function
38+
├── livekit-webhook/ # Livekit webhook handler
39+
├── match-maker/ # User matching function
40+
├── send-otp/ # OTP sending function
41+
├── send-story-notification/ # Story notification function
42+
├── start-friend-call/ # Friend call initiation function
43+
├── sync-all-documents-with-meilisearch/ # Full sync with Meilisearch
44+
├── sync-stories-with-meilisearch/ # Stories sync with Meilisearch
45+
├── sync-users-with-meilisearch/ # Users sync with Meilisearch
46+
├── upcomingRoom-isTime-checker/ # Scheduled room time checker
47+
├── upcomingRoom-Message-Notification/ # Upcoming room notifications
48+
├── verify-email/ # Email verification function
49+
└── verify-otp/ # OTP verification function
50+
```
51+
52+
Each function directory contains:
53+
- `package.json` - Dependencies and configuration
54+
- `README.md` - Function-specific documentation
55+
- `src/` - Source code directory with implementation files
56+
2257
## Functions :
2358

2459
(a) [Room Creation function](functions/create-room) : Function to create rooms in Appwrite and Livekit.
@@ -37,9 +72,21 @@ Go to [this repository](https://github.com/AOSSIE-Org/Resonate) to know more abo
3772

3873
(h) [Verify Email function](functions/verify-email) : Function to verify email ID of users.
3974

40-
(i) [discussion-isTime-checker](functions/discussion-isTime-checker/) : A Cron Function to check all the existent Discussion scheduled timings and comparing to current time in order to activate a discussion if the current time is less than 5 minutes away from the scheduled time
75+
(i) [Database Cleaner function](functions/database-cleaner) : Function to cleanup active pairs and participants collections in the database.
76+
77+
(j) [Send Story Notification function](functions/send-story-notification) : Function to send notifications when new stories are posted.
78+
79+
(k) [Start Friend Call function](functions/start-friend-call) : Function to initiate voice calls between friends.
80+
81+
(l) [Sync All Documents with Meilisearch function](functions/sync-all-documents-with-meilisearch) : Function to synchronize all documents with Meilisearch for search functionality.
82+
83+
(m) [Sync Stories with Meilisearch function](functions/sync-stories-with-meilisearch) : Function to synchronize stories with Meilisearch for search indexing.
84+
85+
(n) [Sync Users with Meilisearch function](functions/sync-users-with-meilisearch) : Function to synchronize user data with Meilisearch for user search.
86+
87+
(o) [Upcoming Room isTime Checker function](functions/upcomingRoom-isTime-checker) : A Cron function to check scheduled room timings and activate rooms when current time is within 5 minutes of scheduled time.
4188

42-
(j) [database-cleaner](functions/database-cleaner/) : Function to cleanup active pairs and participants collections in the database.
89+
(p) [Upcoming Room Message Notification function](functions/upcomingRoom-Message-Notification) : Function to send message notifications for upcoming scheduled rooms.
4390

4491
## Communication Channels
4592

0 commit comments

Comments
 (0)