Update/readme.md and .gitignore

.gitignore

@@ -5,4 +5,6 @@ appwrite/
 **/.env
 **/node_modules/
 **/resonate-service-account.json
-meili_data/
+meili_data/
+/.env
+/node_modules/

README.md

@@ -7,17 +7,45 @@
 
 Go to [this repository](https://github.com/AOSSIE-Org/Resonate) to know more about the project.
 
-## Environment Setup :
+## Environment Setup
 
-1. Pre-requisites :
+1. Pre-requisites
 
     (a) Fork the Repo
 
-    (b) Clone the Repo : `git clone https://github.com/AOSSIE-Org/Resonate-Backend`
+    (b) Clone the Repo: `git clone https://github.com/AOSSIE-Org/Resonate-Backend`
 
-2. Follow [this guide](https://docs.livekit.io/cloud/project-management/keys-and-tokens/) to obtain your `HOST`, `API-KEY`, `API-SECRET` from [livekit-cloud](https://livekit.io/cloud).
+2. Set up environment variables
 
-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).
+```bash
+cp .env.example .env
+```
+
+Then fill in the values in `.env`:
+   - Leave the database/collection IDs as they are (they match the project structure)
+   - Add your Livekit credentials (see step 3)
+   - Add your email credentials (see step 5)
+
+3. Obtain Livekit credentials
+
+- Follow this guide to get your credentials.
+- Add `LIVEKIT_HOST`, `LIVEKIT_API_KEY`, `LIVEKIT_API_SECRET` to your `.env` file.
+
+4. Set up Appwrite
+
+- Create a project on Appwrite Cloud or self-host.
+- Create an API key with necessary scopes.
+- Import the database structure: `appwrite deploy collection`.
+- Copy the generated database and collection IDs into your `.env` file.
+
+5. Email configuration (for OTP functionality)
+
+- Set `SENDER_MAIL` to your email address.
+- Set `SENDER_PASSWORD` to your app password (Gmail guide).
+
+6. Security note
+
+- Do not hardcode secrets in `appwrite.json`. Use environment variables. The template `.env.example` lists all variables required across functions.
 
 ## Functions :
 

appwrite.json

@@ -85,15 +85,15 @@
             "vars": [
                 {
                     "key": "SENDER_MAIL",
-                    "value": "[email protected]"
+                    "value": "$SENDER_MAIL"
                 },
                 {
                     "key": "VERIFICATION_DATABASE_ID",
                     "value": "64a7bfd6b09121548bfe"
                 },
                 {
                     "key": "SENDER_PASSWORD",
-                    "value": "xizkyvzhduejxjel"
+                    "value": "$SENDER_PASSWORD"
                 },
                 {
                     "key": "OTP_COLLECTION_ID",

functions/create-room/src/main.js

@@ -5,6 +5,7 @@ import { throwIfMissing } from "./utils.js";
 export default async ({ req, res, log, error }) => {
     throwIfMissing(process.env, [
         "APPWRITE_API_KEY",
+        "APPWRITE_FUNCTION_PROJECT_ID",
         "MASTER_DATABASE_ID",
         "ROOMS_COLLECTION_ID",
         "LIVEKIT_HOST",

functions/database-cleaner/src/main.js

@@ -4,6 +4,7 @@ import { throwIfMissing } from "./utils.js";
 export default async (context) => {
     throwIfMissing(process.env, [
         "APPWRITE_API_KEY",
+        "APPWRITE_FUNCTION_PROJECT_ID",
         "ROOMS_COLLECTION_ID",
         "PARTICIPANTS_COLLECTION_ID",
         "ACTIVE_PAIRS_COLLECTION_ID",

functions/delete-room/src/main.js

@@ -5,6 +5,7 @@ import { throwIfMissing } from "./utils.js";
 export default async ({ req, res, log, error }) => {
     throwIfMissing(process.env, [
         "APPWRITE_API_KEY",
+        "APPWRITE_FUNCTION_PROJECT_ID",
         "MASTER_DATABASE_ID",
         "ROOMS_COLLECTION_ID",
         "PARTICIPANTS_COLLECTION_ID",

functions/join-room/src/main.js

@@ -3,6 +3,7 @@ import { throwIfMissing } from "./utils.js";
 
 export default async ({ req, res, log, error }) => {
     throwIfMissing(process.env, [
+        "APPWRITE_FUNCTION_PROJECT_ID",
         "LIVEKIT_API_KEY",
         "LIVEKIT_API_SECRET",
         "LIVEKIT_SOCKET_URL",

functions/livekit-webhook/src/main.js

@@ -7,6 +7,7 @@ export default async (context) => {
 
     throwIfMissing(process.env, [
         'APPWRITE_API_KEY',
+        'APPWRITE_FUNCTION_PROJECT_ID',
         'MASTER_DATABASE_ID',
         'ROOMS_COLLECTION_ID',
         'PARTICIPANTS_COLLECTION_ID',

functions/match-maker/src/main.js

@@ -4,6 +4,7 @@ import { throwIfMissing } from './utils.js';
 export default async ({ req, res, log, error }) => {
     throwIfMissing(process.env, [
         'APPWRITE_API_KEY',
+        'APPWRITE_FUNCTION_PROJECT_ID',
         'DATABASE_ID',
         'REQUESTS_COLLECTION_ID',
         'ACTIVE_PAIRS_COLLECTION_ID',

functions/send-otp/src/main.js

@@ -6,6 +6,7 @@ import { randomInt } from "node:crypto"; // for generating cryptographically sec
 export default async ({ req, res, log, error }) => {
     throwIfMissing(process.env, [
         "APPWRITE_API_KEY",
+        "APPWRITE_FUNCTION_PROJECT_ID",
         "VERIFICATION_DATABASE_ID",
         "OTP_COLLECTION_ID",
         "SENDER_MAIL",

functions/verify-email/src/main.js

@@ -2,7 +2,7 @@ import { Client, Users } from 'node-appwrite';
 import { throwIfMissing } from './utils.js';
 
 export default async ({ req, res, log, error }) => {
-    throwIfMissing(process.env, ['APPWRITE_API_KEY']);
+    throwIfMissing(process.env, ['APPWRITE_API_KEY', 'APPWRITE_FUNCTION_PROJECT_ID']);
 
     const client = new Client()
         .setEndpoint(

functions/verify-otp/src/main.js

@@ -4,6 +4,7 @@ import { throwIfMissing } from './utils.js';
 export default async ({ req, res, log, error }) => {
     throwIfMissing(process.env, [
         'APPWRITE_API_KEY',
+        'APPWRITE_FUNCTION_PROJECT_ID',
         'VERIFICATION_DATABASE_ID',
         'OTP_COLLECTION_ID',
         'VERIFY_COLLECTION_ID',