Top

Chatzy Documentation

3rd Party Plugins

NOTE :
- Before running the app make sure you have import Collection json in Firestore database which we have provided.
- Before import json in firestore database remember to give rule permission or create Firestore Data. See the Firebase Rules for create Firestore Database and how to give permission in firebase.
Also you can check below video for how to import json in firebase:
VIDEO URL : https://youtu.be/Jd0sW8Wrc5Y?si=AxC6BmWBFwZfZU4a

GIPHY GIF

  1. This package allow to get gifs, sticker or emojis from GIPHY in pure dart code using Giphy SDK design guidelines.
  2. The fastest and easiest way to bring the full GIPHY experience directly to your app is with the GIPHY SDK.

    3. FOLLOW SIMPLE STEPS BELOW FOR QUICKLY SETUP GIPHY & GET GIPHY API KEY:

    1. Go to GIPHY Developers Official Website https://developers.giphy.com/.
    2. Now create account or login account
    3. After Create Account or Login, Create An App.
    4. Before Create App, SignUp
    5. After Again click on Create App, one pop open for selection SDK or API, click on API Selected
    6. After select Api Selected, click on Next Step
    7. Set your any App Name (Example: Chatzy) & Description & press the Create App button.
    8. Once you have created the GIPHY app successfully, you will find Your Apps Name and Api Key.

      9. There are 2 ways to set your API Key

      1. Copy the API Key and Paste in your project
      2. Paste it in firebase in for that go to firebase project in that go to Firestore Database -> go to config collection -> userAppSetting -> gifAPI

  3. Yuppy 😊!!!!, Now you are ready to Use GIPHY Stickers, GIF & Emojis in your app

AGORA AUDIO - VIDEO CALL

    Note: For using Agora Token you need to have Firebase Billing Account because for access Firebase Function firebase billing account is compulsory.

    After complete your billing account deploy firebase function. Run the below command:

  1. This package allow Voice Calling enables you to add one-to-one or small-group voice communication with smooth, jitter-free streaming to your app. Agora's Voice SDK makes it easy
  2. People engage longer when they see, hear, and interact with each other. The Agora SDK enables you to embed real-time voice and video interaction in any app, on any device, anywhere. Follow the step as per given in document https://docs.agora.io/en/3.x/voice-calling/quickstart-guide/get-started-sdk?platform=flutter

    3. FOLLOW SIMPLE STEPS BELOW FOR QUICKLY SETUP AGORA and Get API KEY:

    1. Go to Agora Developers Official Website https://www.agora.io/en/.
    2. Now, Get Started if Your are new or click on Login if you are already register.
    3. Login with email, github or goole and continue
    4. Close the Pop-up Window (if it appears after creating New account, Close the window as it may lead to error in Project).
    5. In Left hand menu click on Project Management
    6. Click on Create to create a new Agora Project.
      • Set your any App Name (Example: Chatzy)
      • Select the Use case as Others/Others.
      • Select Testing Mode : APP ID since you only need an App ID only.
      • After entering all data submit the data
    8. Your app is in testing mode, for make click on config
    9. Now your app is live
    10. For access agora we need token and channelId/ channelName for that we have created Firebase Function for generating channelId/ channelName and token

      Note: For access Firebase Function you have billing account after that only function will work.

      11. NOTE : If your are working in downloaded Chatzy project which you have downloaded from codecanyon then remember to take backup of functions folder and then follow below steps.

      Follow below steps for deploy the functions:

      1. Firstly login to your firebase with command "firebase login" after that select your project.
      2. After select your project run command "firebase init functions". After apply this command There are 2 option display for codebase selection. Options are:
        1. Initialize
        2. Overwrite
        From this select "Overwrite"
      3. After that Again Option selection came for language selection for code written in firebase . Option are
        1. JavaScript
        2. TypeScript
        3. Python
        From above option select the "JavaScript" Option
      4. After the option selected they will asked for ESLInt to catch probable bugs and enforce style so just write “y” and enter it
      5. Now they will ask for package.json file for overwrite this option is show because the functions folder is already there so just write “n”
      6. Now the will ask for index.js and .eslintrc.js file for overwrite in that also just write “y”
      7. Now again overwrite option came for .gitignore so same answer enter “n”
      8. Now last option is too install dependencies with npm so give ‘y’
      9. Now go to downloaded Chatzy project which you have downloaded from codecanyon. In that go to functions folder in that index.js file. Copy whole code and paste it in you functions -> index.js file
      10. Now time to deploy if facing issue while deploy like eslint command not found or lint command not found then run command 
        npm install eslint —save-dev
      11. Now deploy the function by apply below command
        12. firebase deploy --only functions

      NOTE : While audio or video call or while click on audio or video call button if any cloud function error: PERMISSION_DENIED: issue occur then follow the below steps :.

      1. Go to Googgle Cloud Console select your project.
      2. Search Cloud Function and select it
      3. Now check on checkbox with generateToken name. After checkbox select click on Permission
      4. Now click on Add Principal
      5. Give new Principal title allUsers and select Role Cloud Functions Invoker
    11. Yuppy 😊!!!!, Now you are ready to Use Agora in your app