Setup

1. Install the google-cloud-sdk brew install google-cloud-sdk or if you use nix envdir, it should be installed for you

2. You will need to have your own Google Cloud Project (please refer to the App Docs on how to setup Firebase). If you did setup Firebase for the App, then you'll already have a Project in Google Cloud. Make sure you have the Cloud Resource Manager and Firebase Management API permissions at the minimum in the Google Cloud API Console

3. Run the following commands one by one

   gcloud auth login
   gcloud config set project <project-id>
   gcloud auth application-default login --project <project-id>
   

   Replace <project-id> with your Google Cloud Project ID This should generate the application_default_credentials.json file in the ~/.config/gcloud directory. This file is read automatically by gcloud in Python, so you don’t have to manually add any env for the service account.

4. Install Python (use brew if on mac) (or with nix env it will be done for you)

5. Install pip (if it doesn’t exist)

6. Install git and ffmpeg (use brew if on mac) (again nix env installs this for you)

7. Move to the backend directory (cd backend)

8. Run the command cat .env.template > .env

9. For Redis (you can use upstash, sign up and create a free instance)

10. Add the necessary keys in the env file (OpenAI, Deepgram, Redis, set ADMIN_KEY to 123)

11. Run the command pip install -r requirements.txt to install required dependencies

12. Sign Up on ngrok and follow the steps to configure it

13. During the onboarding flow, under the Static Domain section, Ngrok should provide you with a static domain and a command to point your localhost to that static domain. Replace the port from 80 to 8000 in that command and run it in your terminal

    ngrok http --domain=example.ngrok-free.app 8000
    

14. Run the following command to start the server

    uvicorn main:app --reload --env-file .env
    

15. If you get any error mentioning no internet connection or something while downloading models, then add the following lines in the utils/stt/vad.py file after the import statements.

    import ssl
    ssl._create_default_https_context = ssl._create_unverified_context
    

16. Now try running the uvicorn main:app --reload --env-file .env command again.

17. Assign the url given by ngrok in the app’s env to API_BASE_URL

18. Now your app should be using your local backend