{"id":20078101,"url":"https://github.com/quickblox/q-municate-android","last_synced_at":"2025-04-05T16:10:21.259Z","repository":{"id":147244542,"uuid":"20729728","full_name":"QuickBlox/q-municate-android","owner":"QuickBlox","description":"Qmunicate Android chat application","archived":false,"fork":false,"pushed_at":"2024-06-26T11:02:42.000Z","size":502,"stargazers_count":254,"open_issues_count":0,"forks_count":198,"subscribers_count":61,"default_branch":"master","last_synced_at":"2025-03-29T15:08:45.148Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/QuickBlox.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-06-11T15:08:00.000Z","updated_at":"2024-11-27T02:44:48.000Z","dependencies_parsed_at":"2023-12-22T16:47:57.661Z","dependency_job_id":"ee7e0e48-20eb-4c6e-8643-7f655289e223","html_url":"https://github.com/QuickBlox/q-municate-android","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QuickBlox%2Fq-municate-android","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QuickBlox%2Fq-municate-android/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QuickBlox%2Fq-municate-android/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QuickBlox%2Fq-municate-android/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/QuickBlox","download_url":"https://codeload.github.com/QuickBlox/q-municate-android/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247361695,"owners_count":20926643,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T15:12:51.735Z","updated_at":"2025-04-05T16:10:21.235Z","avatar_url":"https://github.com/QuickBlox.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n\u003cp\u003e\n\t\t\u003ca href=\"https://discord.com/invite/3cKRunq8ZZ\"\u003e\u003cimg src=\"https://img.shields.io/discord/1042743094833065985?color=5865F2\u0026logo=discord\u0026logoColor=white\u0026label=QuickBlox%20Discord%20server\u0026style=for-the-badge\" alt=\"Discord server\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003c/div\u003e\n\n# Before you begin\n\nRegister a new account following [this link](https://admin.quickblox.com/signup). Type in your email and password to\nsign in. You can also sign in with your Google or Github accounts.\nCreate the app clicking New app button.\nConfigure the app. Type in the information about your organization into corresponding fields and click Add button.\nGo to Dashboard =\u003e YOUR_APP =\u003e Overview section and copy your Application ID, Authorization Key, Authorization Secret,\nand Account Key .\n\n# To launch th Q-municate\n\nTo launch the project you need to take a few simple steps\n\n## Step 1\n\n1. Clone the repository using the link below:\n\n```\n    git clone https://github.com/QuickBlox/q-municate-android.git\n```\n\n2. Go to menu **File =\u003e Open Project**. (Or \"Open an existing Project\" if Android Studio is just opened)\n3. Select a path to the Q-municate project.\n\n## Step 2\n\nAdd the following properties to the **project-level local.properties** file\n\n### 1. Keystore properties\n\nThese properties are needed so that you can sign your builds depending on the types you need to **debug** or **release**\n\n```\n#\n### Debug keystore properties\ndebug_store_file=../keystore/debug.jks // the path where is the your debug key\ndebug_store_password= // debug store password for your key\ndebug_key_alias= // debug key alias for your key\ndebug_key_password= // debug key password for your key\n#\n### Release keystore properties\nrelease_store_file=../keystore/release.jks // the path where is the your release key\nrelease_store_password= // release store password for your key\nrelease_key_alias= // release key alias for your key\nrelease_key_password= // release key password for your key\n\n```\n\n### 2. Firebase properties\n\nThis application uses Firebase for authorization by phone number, therefore you need to specify the parameters required\nfor it. These properties can be found in **Project settings** particular project in the FireBase console\nat [this link](https://console.firebase.google.com/). If you haven't already created a FireBase\nproject, [add Firebase to your Android project](https://firebase.google.com/docs/android/setup).\nInformation on how to enable phone number sign-in in Firebase you can find\nby [this link](https://firebase.google.com/docs/auth/android/phone-auth#enable-phone-number-sign-in-for-your-firebase-project).\n\n\u003cp float=\"centr\"\u003e\n\u003cimg src=\"screenshots/firebase-settings.png\" /\u003e\n\u003c/p\u003e\n\n```\n#\n### Firebase properties\nfirebase_app_id=\"\" // firebase app id\n```\n\n### 3. QuickBlox properties\n\nThese properties you need to init QuickBlox SDK.\nHow to get credentials is described in the [Before you begin](#before-you-begin) section.\n\n```\n#\n### QuickBlox properties\nquickblox_app_id=\"\" // QuickBlox app_id your application\nquickblox_auth_key=\"\" // QuickBlox auth_key your application\nquickblox_auth_secret=\"\" // QuickBlox auth_secret your application\nquickblox_account_key=\"\" // QuickBlox account_key your application\nquickblox_api_endpoint=\"\" // QuickBlox api_endpoint your application\nquickblox_chat_endpoint=\"\" // QuickBlox chat_endpoint your application\n```\n\n### 4. QuickBlox AI properties\n\nThese properties need to use QuickBlox AI libraries. The QuickBlox AI libraries can be used with two different\napproaches. Either directly, using the libraries with raw Open AI token, or with a QuickBlox session token via a proxy\nserver. We recommended using the proxy server method. Please ensure you use the latest method which you can check in\nour [repository](https://github.com/QuickBlox/qb-ai-assistant-proxy-server).\n\n```\n#\n### QuickBlox AI\nquickblox_open_ai_token=\"\" // your open ai token\nquickblox_ai_proxy_server_url=\"\" // proxy server URL\n```\n\n### Common example of completed properties\n\n```\n#\n### Debug keystore properties\ndebug_store_file=../keystore/my-debug-key.jks \ndebug_store_password=my-debug-store-password\ndebug_key_alias=my-debug-alias\ndebug_key_password=my-debug-key-password\n#\n### Release keystore properties\nrelease_store_file=../keystore/my-release-key.jks \nrelease_store_password=my-release-store-password\nrelease_key_alias=my-release-alias\nrelease_key_password=my-release-key-password\n#\n### Firebase properties\nfirebase_app_id=\"my-firebase-app-123\"\n#\n### QuickBlox properties\nquickblox_app_id=\"67895\"\nquickblox_auth_key=\"lkjdueksu7392kj\" \nquickblox_auth_secret=\"BTFsj7Rtt27DAmT\" \nquickblox_account_key=\"9yvTe17TmjNPqDoYtfqp\" \nquickblox_api_endpoint=\"api.endpoint.com\"\nquickblox_chat_endpoint=\"chat.endpoint.com\" \n#\n### QuickBlox AI\nquickblox_open_ai_token=\"qwerty123qwedsfjHDSJHdjhqkldsqjdsaklja\"\nquickblox_ai_proxy_server_url=\"https://proxy.url\"\n#\n### Terms of Service and Privacy Policy\ntos_url=\"https://tos.url\"\nprivacy_policy_url=\"https://privacy_policy.url\"\n```\n\n## Step 3\n\nFor authorization to work correctly, you will need to add a configuration file for FireBase. Download the **google-services.json** file from **Project settings** your project in\nthe [FireBase console](https://console.firebase.google.com/) then add this file to the module (app-level) root directory\nof your app. Detailed information can be found\nat [this link](https://firebase.google.com/docs/android/setup#add-config-file).\n\n\u003cp float=\"centr\"\u003e\n\u003cimg src=\"screenshots/google-json.png\" /\u003e\n\u003c/p\u003e\n\n## Step 4\n\nAfter setting up all the properties and configurations described in the steps above, you can run the project. To do\nthis, you will need to connect a real Android device or emulator to Android Studio and then click the **Run** button.\n\n\u003cp float=\"centr\"\u003e\n\u003cimg src=\"screenshots/run.png\" /\u003e\n\u003c/p\u003e\n\n\n## License\n\nAIAnswerAssistant is released under the [MIT License](LICENSE.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquickblox%2Fq-municate-android","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fquickblox%2Fq-municate-android","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquickblox%2Fq-municate-android/lists"}