Skip to content

Commit f56e574

Browse files
dimaspiritsoulfly
authored andcommitted
Add the github helpers files (#128)
Added github helpers files
1 parent b30ab4a commit f56e574

32 files changed

+48
-40
lines changed

.github/CONTRIBUTING.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# How to contribute
2+
3+
First off, thanks that you help us to make Quickblox better.
4+
5+
Feedback and suggestions for improvement always welcome :)
6+
7+
## Modify and build the library
8+
9+
The quickblox.js library is build from a number of **CommonJS modules** contained in the `src` folder. For example the `src/modules/qbUsers.js` module contains the code that deals with the [Users API](http://quickblox.com/developers/Users).
10+
11+
These modules are combined through [browserify](http://browserify.org/) into a single `quickblox.js` file in the root and so this is the only file that needs to be included in a `<script>` tag OR in a RequireJS application OR in Node.js environment (everywhere). To build the library, use the [Grunt](http://gruntjs.com/) task runner.
12+
13+
* You need to have the dependencies listed in the package.json available, use `npm install` to load them;
14+
* Install **grunt-cli** `npm install -g grunt-cli`;
15+
* Also you need install **jasmine** global `npm i -g jasmine` for tests;
16+
* Change the 'version' properties in next files:
17+
* https://github.com/QuickBlox/quickblox-javascript-sdk/blob/gh-pages/src/qbConfig.js;
18+
* https://github.com/QuickBlox/quickblox-javascript-sdk/blob/gh-pages/bower.json;
19+
* https://github.com/QuickBlox/quickblox-javascript-sdk/blob/gh-pages/package.json;
20+
* Rebuild SDK: `grunt`;
21+
* Update README.md;
22+
* Commit your changes to git repository and create a new "git tag" for new version. This action updates SDK for GIT and also for bower package manager;
23+
* `npm publish`. This action updates SDK for node package manager, but maybe you will be needed some author credentials for it (you should be in owner list);
24+
* Update QuickBlox developers section.

Gruntfile.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ module.exports = function (grunt) {
2828
},
2929
all: {
3030
files: {
31-
'quickblox.js': ['js/qbMain.js']
31+
'quickblox.js': ['src/qbMain.js']
3232
}
3333
}
3434
},
@@ -45,7 +45,7 @@ module.exports = function (grunt) {
4545
},
4646

4747
watch: {
48-
files: ['js/*.js', 'js/modules/*.js', 'js/modules/webrtc/*.js'],
48+
files: ['src/*.js', 'src/modules/*.js', 'src/modules/webrtc/*.js'],
4949
tasks: ['browserify', 'notify:browserify', 'uglify', 'notify:uglify'],
5050
options: {
5151
spawn: false,

README.md

Lines changed: 2 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -72,24 +72,8 @@ Please raise questions, requests for help etc. via http://stackoverflow.com/ques
7272

7373
Feedback and suggestions for improvement always welcome :)
7474

75-
# Modifying and building the library
76-
77-
The quickblox.js library is build from a number of **CommonJS modules** contained in the `js` folder. For example the `js/modules/qbUsers.js` module contains the code that deals with the [Users API](http://quickblox.com/developers/Users).
78-
79-
These modules are combined through [browserify](http://browserify.org/) into a single `quickblox.js` file in the root and so this is the only file that needs to be included in a `<script>` tag OR in a RequireJS application OR in Node.js environment (everywhere). To build the library, use the [Grunt](http://gruntjs.com/) task runner:
80-
81-
* You need to have the dependencies listed in the package.json available, use `npm install` to load them.
82-
* Install **grunt-cli** `npm install -g grunt-cli`
83-
* Also you need install **jasmine** global `npm i -g jasmine` for tests.
84-
* Change the 'version' properties in next files:
85-
* https://github.com/QuickBlox/quickblox-javascript-sdk/blob/gh-pages/js/qbConfig.js
86-
* https://github.com/QuickBlox/quickblox-javascript-sdk/blob/gh-pages/bower.json
87-
* https://github.com/QuickBlox/quickblox-javascript-sdk/blob/gh-pages/package.json
88-
* Rebuild SDK: `grunt`
89-
* Update README.md
90-
* Commit your changes to git repository and create a new "git tag" for new version. This action updates SDK for GIT and also for bower package manager.
91-
* `npm publish`. This action updates SDK for node package manager, but maybe you will be needed some author credentials for it (you should be in owner list)
92-
* Update QuickBlox developers section
75+
# How to contribute
76+
See more information at [contributing.md](https://github.com/QuickBlox/quickblox-javascript-sdk/blob/gh-pages/.github/CONTRIBUTING.md)
9377

9478
# License
9579
BSD

bower.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
"ignore": [
3434
"**/.*",
3535
"examples",
36-
"js",
36+
"src",
3737
"lib",
3838
"node_modules",
3939
"plugins",

quickblox.min.js

Lines changed: 10 additions & 10 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

spec/QB-ChatSpec.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ describe('Chat API', function() {
88

99
var isNodeEnv = typeof window === 'undefined' && typeof exports === 'object';
1010

11-
var QB = isNodeEnv ? require('../js/qbMain') : window.QB;
11+
var QB = isNodeEnv ? require('../src/qbMain') : window.QB;
1212
var CREDENTIALS = isNodeEnv ? require('./config').CREDENTIALS : window.CREDENTIALS;
1313
var QBUser1 = isNodeEnv ? require('./config').QBUser1 : window.QBUser1;
1414
var QBUser2 = isNodeEnv ? require('./config').QBUser2 : window.QBUser2;

spec/QB-ContentSpec.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ describe('Content API', function() {
44
var REST_REQUESTS_TIMEOUT = 3000;
55

66
var isNodeEnv = typeof window === 'undefined' && typeof exports === 'object';
7-
var QB = isNodeEnv ? require('../js/qbMain') : window.QB;
7+
var QB = isNodeEnv ? require('../src/qbMain') : window.QB;
88
var CREDENTIALS = isNodeEnv ? require('./config').CREDENTIALS : window.CREDENTIALS;
99
var QBUser1 = isNodeEnv ? require('./config').QBUser1 : window.QBUser1;
1010

spec/QB-CoreSpec.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ describe('Session API', function() {
66
var isNodeEnv = typeof window === 'undefined' && typeof exports === 'object';
77
var request = isNodeEnv ? require('request') : {};
88

9-
var QB = isNodeEnv ? require('../js/qbMain') : window.QB;
9+
var QB = isNodeEnv ? require('../src/qbMain') : window.QB;
1010
var CREDENTIALS = isNodeEnv ? require('./config').CREDENTIALS : window.CREDENTIALS;
1111
var CONFIG = isNodeEnv ? require('./config').CONFIG : window.CONFIG;
1212
var QBUser1 = isNodeEnv ? require('./config').QBUser1 : window.QBUser1;

spec/QB-DataSpec.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ describe('Custom Objects API', function() {
77
var isNodeEnv = typeof window === 'undefined' && typeof exports === 'object';
88
var request = isNodeEnv ? require('request') : {};
99

10-
var QB = isNodeEnv ? require('../js/qbMain') : window.QB;
10+
var QB = isNodeEnv ? require('../src/qbMain') : window.QB;
1111
var CREDENTIALS = isNodeEnv ? require('./config').CREDENTIALS : window.CREDENTIALS;
1212
var CONFIG = isNodeEnv ? require('./config').CONFIG : window.CONFIG;
1313
var QBUser1 = isNodeEnv ? require('./config').QBUser1 : window.QBUser1;

spec/QB-LocationSpec.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ describe('Location API', function() {
44
var isNodeEnv = typeof window === 'undefined' && typeof exports === 'object';
55
var request = isNodeEnv ? require('request') : {};
66

7-
var QB = isNodeEnv ? require('../js/qbMain') : window.QB;
7+
var QB = isNodeEnv ? require('../src/qbMain') : window.QB;
88
var CREDENTIALS = isNodeEnv ? require('./config').CREDENTIALS : window.CREDENTIALS;
99
var CONFIG = isNodeEnv ? require('./config').CONFIG : window.CONFIG;
1010
var QBUser1 = isNodeEnv ? require('./config').QBUser1 : window.QBUser1;

spec/QB-PushnotificationsSpec.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ describe('PushNotifications API', function() {
55

66
var isNodeEnv = typeof window === 'undefined' && typeof exports === 'object';
77

8-
var QB = isNodeEnv ? require('../js/qbMain') : window.QB;
8+
var QB = isNodeEnv ? require('../src/qbMain') : window.QB;
99
var CREDENTIALS = isNodeEnv ? require('./config').CREDENTIALS : window.CREDENTIALS;
1010
var CONFIG = isNodeEnv ? require('./config').CONFIG : window.CONFIG;
1111
var QBUser1 = isNodeEnv ? require('./config').QBUser1 : window.QBUser1;

spec/QB-UsersSpec.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ describe('Users API', function() {
66
var isNodeEnv = typeof window === 'undefined' && typeof exports === 'object';
77
var request = isNodeEnv ? require('request') : {};
88

9-
var QB = isNodeEnv ? require('../js/qbMain') : window.QB;
9+
var QB = isNodeEnv ? require('../src/qbMain') : window.QB;
1010
var CREDENTIALS = isNodeEnv ? require('./config').CREDENTIALS : window.CREDENTIALS;
1111
var CONFIG = isNodeEnv ? require('./config').CONFIG : window.CONFIG;
1212
var QBUser1 = isNodeEnv ? require('./config').QBUser1 : window.QBUser1;
@@ -19,7 +19,7 @@ describe('Users API', function() {
1919
done.fail("Create session error: " + JSON.stringify(err));
2020
} else {
2121
expect(result).not.toBeNull();
22-
22+
2323
done();
2424
}
2525
}, REST_REQUESTS_TIMEOUT);

spec/QB-WebRTCSpec.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ describe('WebRTC API', function() {
44

55
var isNodeEnv = typeof window === 'undefined' && typeof exports === 'object';
66

7-
var QB = isNodeEnv ? require('../js/qbMain') : window.QB;
7+
var QB = isNodeEnv ? require('../src/qbMain') : window.QB;
88
var CREDENTIALS = isNodeEnv ? require('./config').CREDENTIALS : window.CREDENTIALS;
99
var CONFIG = isNodeEnv ? require('./config').CONFIG : window.CONFIG;
1010
var QBUser1 = isNodeEnv ? require('./config').QBUser1 : window.QBUser1;
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)