Q-municate Web chat application
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
app
.bowerrc
.gitignore
.jshintrc
.yo-rc.json
Gruntfile.js
LICENSE
README.md
bower.json
index.html
package-lock.json
package.json

README.md

Q-municate

Q-municate is an open source code chat application with wide range of communication features available (such as one-to-one messaging, group chat messaging, file transfers, notifications, Facebook signup and audio/video calls).

We are please to present you with an out of the box chat application. You can customize this application depending of your needs. QuickBlox is used for the backend.

Find the source code and more information about Q-municate in our Developers section: http://quickblox.com/developers/q-municate

Q-municate Web

This description was written by the QuickBlox Web team in order to fully explain how you can build a communication javascript app with the Quickblox API.

Q-municate is designed for all developers, including beginners, as we move from simple to more complex implementation. Enjoy and please get in touch if you need any assistance.

Live demo

Releases and changelog

See the Releases section for changelogs for each release version of Q-municate.

Software Environment

  • The web component is based on the QuickBlox platform

  • The user interface is in English

  • No crashes or exceptions are allowed

  • The app immediately reacts to any user action or give notifications about each action which requires time to be processed

  • User information is kept safely and securely.

  • User's password is encoded and kept in the local storage.

  • The App should work correctly in the following browsers:

Browser Edge IE Firefox Chrome Safari Opera
version 14+ 11+ 46+ 50+ 9+ 37+
note 1, 2 1, 2, 3 - - 2 -
  • (1) note: recommended BOSH connection (Configuration)
  • (2) note: without audio/video calls
  • (3) note: without local notifications

Q-municate is a fully fledged chat application using the Quickblox API.

How to build your own Chat app

You can build your own chat app using Q-municate as a basis in just 5 minutes! All you need is to:

1. Register a QuickBlox account

If you don't have one yet, just register your account at https://admin.quickblox.com/register

You can read more about how to create an account here.

2. Login to QuickBlox admin panel

Login into admin panel at https://admin.quickblox.com/signin You can read more about how to sign in to admin panel here.

3. Create a new app.

Click on the "Add new application" button after "Log in": https://admin.quickblox.com and fill an application form. If you don't have an app yet, you can follow a detailed guide about app creation at here.

4. Get app credentials

Click on the app title in the list to reveal the app details. You are going to need App ID, Authorization key and Authorization secret later in our Q-municate source code.

5. Setup environment

If you want to build your own app using Q-municate as a base, please do the following:

  1. Install nodeJS and Ruby before start.
  2. Download the project from GitHub.
  3. Run npm install -g bower in your terminal as an administrator.
  4. Run gem install sass in your terminal as an administrator.
  5. Run npm install -g grunt-cli in your terminal as an administrator.
  6. Run bower install to install all additional packages in your terminal.
  7. Run npm install to install all additional packages in your terminal as an administrator.
  8. Copy the credentials (App ID, Authorization key, Authorization secret) and your Facebook App ID (How to generate and save Facebook application ID) into your Q-municate project code in config.js.

6. Build and run

  1. Run grunt build or grunt (build with jshint verification) in your terminal to build Q-municate (q-municate-web/dist).
  2. Run grunt serve in your terminal to open Q-municate in a browser window (https://localhost:9000).

License

Apache License Version 2.0