5 Minute Guide

Ask tech team
From QuickBlox Developers (API docs, code samples, SDK)
Jump to: navigation, search

Contents

Welcome to QuickBlox, where you can get your cloud backend running in just 5 minutes! All you need is to:

  1. Register a free QuickBlox account and add your App there.
  2. Download SDK / code sample for your platform.
  3. Update credentials in your application code.

Detailed instructions below:

Create your QuickBlox account

Go to https://admin.quickblox.com and click on “Register” at the top or just follow the link: https://admin.quickblox.com/register.

Register your account.jpg

Note: you need to accept the Terms and Conditions in order to proceed. To read the Terms and Conditions just follow the link next to the checkbox.

Click on the button Sign Me Up at the bottom of the page. You will receive a confirmation e-mail shortly. Confirm your registration by following the link in the e-mail.

Registration confirmation.jpg

Congratulations! You've been registered!

Sign in to the admin panel

Follow the link https://admin.quickblox.com/signin, enter your Login and Password and click on the Sign In Now button.

Log In.jpg

Create an app in the admin panel

Upon sign in you will see the main page where you need to find the "Add new application" button and click on it.

Add new app 1.jpg

Next step is to fill the "Add new application" form. Here you need to enter the information such as the title of your app, its website, type (game, fun, office, productivity and other are possible) and description. Note: Fields "Title" and "Type" are mandatory, others are optional.

Add new app form 1.jpg

Click on the button "Add" in the bottom. The app will appear in the list of your apps.

List of apps.jpg

Click on app title to view/edit its credentials.

You will see the auto-generated values of the application id, your account id, authorization key and authorization secret. These are important - your app needs to use these credentials so that server knows who's there.

Note: You may also see modules icons: Location, Users, Message, Content, Custom Objects, Ratings, Chat - feel free to click on them and experiment with admin panels for those features.

Info about app.jpg

Launch the iOS code sample

Download the code sample project

Code samples are simple demo projects that have been created to help you learn and experiment with QuickBlox APIs. They are available on GitHub as open source projects. You may clone them and either play and learn OR build your real app on top of them. To download any code sample from GitHub, follow this link: http://quickblox.com/developers/IOS#Code_samples, choose any sample (e.g. Location) and click on "Download ZIP" in the top of the page.

DownloadSampleApp.png

Open code sample in Xcode

Unzip the downloaded archive, open folder sample-location and open *.xcodeproj file. The project will open. Note: The Xcode must be installed on your computer.

RunSampleApp.png

Update authentication credentials

Replace the authentication credentials in the Sample with the credentials you have copied from the admin panel. To do this you need to open the *.xcodeproj file and find AppDelegate.m using the left sidebar. Find the credentials variables and update them with the values you have copied from admin panel.

SetCredentialsiOS.png

Go into admin panel and click on app title again if necessary. Just copy and paste, the parameters you are looking for are:

- Application id;
- Authorization key;
- Authorization secret.

AdminCredentials.png

Launch the sample

To test the app you should click on the "Run" button at the top left corner of Xcode window and wait for a few seconds. App will be compiled and launched in the Simulator. If you have done everything right, you will see the first screen of the app otherwise the errors will appear.

SampleResult.png

Launch the Android code sample

Download the code sample project

Code samples are simple demo projects that have been created to help you learn and experiment with QuickBlox APIs. They are available on GitHub as open source projects. You may clone them and either play and learn OR build your real app on top of them. To download any code sample from GitHub, follow this link: http://quickblox.com/developers/Android#Code_samples, choose any sample (e.g. Location) and click on "Download ZIP" in the top of the page.

5MinGuideAndroid1.png

Open code sample in IDEA/Eclipse

Unzip the downloaded archive, open folder sample-location, then open in IDE:

Run samples on IDEA IDE Go to menu File - New Project. Select Create project from existing sources, select path to sample in Project files location field, click some times Next and Finish.

Run samples on Eclipse IDE Go to menu File - New - Project. Select Android Project from Existing Code and Browse to your project-directory, click Finish.

Update authentication credentials

Replace the authentication credentials in the Sample with the credentials you have copied from the admin panel. To do this you need to open the project and find class SplashActivity.java using the left sidebar. Find the credentials variables and update them with the values you have copied from admin panel.

5MinGuideAndroid2.png

Go into admin panel and click on app title again if necessary. Just copy and paste, the parameters you are looking for are:

- Application id;
- Authorization key;
- Authorization secret.

AdminCredentials.png

Launch the sample

To test the app you should run it. App will be compiled and launched in the Simulator/Device. If you have done everything right, you will see the the app otherwise the errors will appear.

5MinGuideAndroid3.png

Congratulations! You have successfully created your own cloud backend and connected to it. You may now play with the code sample you have connected or do the same for your existing app.

Good luck with your apps!