Documentation
Dreamschat Web - Documentation
Architecture and Install Instructions
Here are the install instructions and architecture of the complete product for you.
Architecture
DreamChat is done using PHP(CodeIgnitor framework) based web application. And Database is directly used in FireBase
Install Instruction
To be able to install the application we just need a WebServer and a FireBase Database instance with SMS based authentication
System Requirements
WebServer
- GoDaddy or similar hosting
- ApacheServer
- PHP 5.4+ (8.2.4)
FireBaseDatabase
- Create Project & Database
- SMS Authenticationenabled
Step 1: Copy the files to the server
You can use ‘WinSCP’ or FTP tools to copy your files to the server. Copy the entier folder ‘DreamChatWeb’ to the root folder, it contains the ‘index.php’ which will the first file to be called. Copy the ‘DreamsChatWeb.zip’ and then unzip in the server or copy as a folder.
Once the file is load online. Unzip the file to extract its content.
Once the files are loaded, make sure it has the permissions as ‘755’ so that read is possible for all users accessing
Step 5: Login and Configure
Once the configuration is done, you are now ready to connect to the website and configure the web application.
Before login to Admin you need to create a auth user in firebase database on below credentials. Once you created the firebase database,
Go to Authentication -> Users -> To click Add User -> Then enter the Email([email protected]) and Password(123456) -> Click Add User button
Once the auth admin user created you can able to login the below mentioned login details.
Admin Login Credentials
https://yourdomain.com/admin/
Username:[email protected]
Password:123456
Firebase
Create and Configure Firebase
Go to fierbase console -> www.firebase.google.com
Create Project
Give a resource and domain
Now WebApp is ready
Step 8: Create Database
You can get the URL for the database here
Step 9: Create Storage For Image/Video Upload
If storage is not created/configured properly Images/Video uploads will not work properly.
Select the region closed to where the app will be used, so that it will be faster
Here you can get the storage details
Step 10: Enable Authentication
Go to Build->Authentication
Step 11: Hostname Configure In Firebase
Add your domain to the list.
Step 12: Get Config And Update In Admin Panel
Under General settings you can see the configuration
Add all these config to
https://yourdomain.com/admin/
Username:admin
Password:123456
Agora
Setup Agora
1. First Create your agora account, by clicking this link,
https://www.agora.io/en
2.Create the account by the following steps.
3. Create new project by providing the project name and click
4. Click next and close in next steps.
5. Create the new project by providing the project name and make sure the testing mode is enabled and submit
6. Change the app to live and save the project and make sure the app primary certificate is disable
Use the Appid key in Agora Settings
Frequently Asked Questions
FAQ 1 – Admin Panel settings
Admin Dashboard
Default page after successful login by admin. Following details are visible to admin.
- Total number of users
- Total number of call count
- Total number of chat count
- Total number of Groups count
- Recent User List
- Recent Group List
Users
Admin has the option to view all active and inactive users. Also, has an option to ‘Delete’
Blocked Users
Admin can view all blocked users details. Also has an option to ‘Unblock’ or ‘Delete’
Reported Users
Admin can view all Reported users details. Also has an option to ‘Delete’
Chat List
Here admin can view From chat and To chat details and chat counts. And also has an option to ‘View Chat’ or ‘Delete’
Call History
In call history tab admin can view total cal history like Total Incoming Call,Total Outgoing Call,Total Missed Call.And also has an option to ‘Delete’.
Stories List
Admin can view all Stories details. Also has an option to ‘Delete’
Admin Settings
Admin can have the settings previlages
FAQ 2 - Web App Features
User Signup
Once you have entered the mobile number, Username, Password and Email, Authentication user also created in firebase databse.
User Login
Once you regegistered your mobile number, username and password you have login to using Email & Password.
Chat
In home page user can chat their Dreams chat registered members and user can view and search profile picture and about.And also has an option to ‘Block User’, ‘Delete Chat’, Forward Chat’, Reply Chat’.
Logged in user can add friends by Add a contact through contact after you click the chat icon to create a new chat.
User can upload photos, videos, documents to particular friends.
User can upload audio message to particular friends.
In dreams chat users can chat with smileys.
User can able to forward a message to particular friends.
User can able to reply the particular messages.
Group Chat
User can view their group members conversations,And also user can change group Profile picture,Group info and group members.Also group members have an option to exit group or delete chat.
User can create their group name and descriptions for their friends or family members,etc...
User can add dreams chat members into created group.
Status
If users post a status then all dreamchat members can see that user status in status tab.
Logged in users can add their status(Image) through add status(+) button.
Call
In call tab user can view all their call activities like missed calls,Other calls and call logs.
Dreams chat users can single audio or video call and group audio or video call to their drams chat contact members and groups.
Settings
Dreams chat users edit thier profile details like Display name,Display picture,Status.
Dreams chat users have able to change the password in settings module.
Dreams chat users have able to change the chats background through settings module.
Dreams chat users have able to delete his own account in settings module.
Support
If you have any queries please contact us through email: [email protected].