Resonate - An Open Source Social Voice Platform
This project is divided into two repositories:
- Resonate Flutter App
- Resonate Backend (You are here)
Go to this repository to know more about the project.
Environment Setup :
-
Pre-requisites :
(a) Clone the Repo :
git clone https://github.com/AOSSIE-Org/Resonate-Backend
(b) Run this command to install required dependencies from package.json :
npm install
-
Create a
.env
file in the project's root directory -
Follow this guide to obtain your
HOST
,API-KEY
,API-SECRET
from livekit-cloud. -
Create a new project on Appwrite Cloud or self host it locally by pulling their docker image. Know more about Appwrite here.
-
The
.env
file should consist of :(a)
LIVEKIT_API_KEY
(b)
LIVEKIT_API_SECRET
(c)
LIVEKIT_HOST
(d)
LIVEKIT_SOCKET_URL
(e)
APPWRITE_ENDPOINT
(f)
APPWRITE_PROJECT_ID
(g)
APPWRITE_SECRET_API_KEY
-
There are 3 appwrite cloud functions needed for maintaining the functionality of Resonate
(a)
send_otp
- Sending emails to users with the otp while email verification(b)
verify_otp
- Verifies the user entered otp with the otp sent to his mail for email verification(c)
set_email_verified
- Sets the user account as email verified once email verification is successfulEach of these functions have their own respective appwrite.json files one for each function which has the API keys used in that function and is necessary while using Appwrite's CLI for deployments (commonly preferred).
The appwrite.json files are put into .gitignore please do request for them on AOSSIE's discord server in order to contribute to Resonate's appwrite cloud functions
Communication Channels
If you have any questions, need clarifications, or want to discuss ideas, feel free to reach out through the following channels:
We appreciate your contributions and look forward to working with you to make this project even better!