Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/CloudBoost/cloudboost
Realtime JavaScript Backend.
https://github.com/CloudBoost/cloudboost
api baas backend-as-a-service backend-services backendless cloud-platform docker realtime realtime-database search storage-api
Last synced: about 2 months ago
JSON representation
Realtime JavaScript Backend.
- Host: GitHub
- URL: https://github.com/CloudBoost/cloudboost
- Owner: CloudBoost
- License: apache-2.0
- Created: 2016-02-08T13:45:32.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2024-04-14T17:51:05.000Z (8 months ago)
- Last Synced: 2024-04-15T15:58:55.460Z (8 months ago)
- Topics: api, baas, backend-as-a-service, backend-services, backendless, cloud-platform, docker, realtime, realtime-database, search, storage-api
- Language: JavaScript
- Homepage: https://www.cloudboost.io
- Size: 63.6 MB
- Stars: 1,439
- Watchers: 51
- Forks: 195
- Open Issues: 239
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Governance: GOVERNANCE.md
Awesome Lists containing this project
- awesome-repositories - CloudBoost/cloudboost - Realtime JavaScript Backend. (JavaScript)
- awesome-starred - CloudBoost/cloudboost - Realtime JavaScript Backend. (docker)
- awesome-list-docker - cloudboost
README
[](https://travis-ci.org/CloudBoost/cloudboost)
[](#backers)
CloudBoost is the complete cloud platform for your app. **Think of CloudBoost as Parse + Firebase + Algolia + Iron.io all combined into one** :
- Data-Storage / JSON Storage / BLOB Storage
- 100% data ownership
- Realtime
- Search
- More - ACL's, User Authentication, and more.
CloudBoost also has a [managed service](https://www.cloudboost.io), so you don't have to install or configure anything. You can sign up for the managed service [here.](https://www.cloudboost.io)
## Deploy with Docker (recommended)
You can install CloudBoost anywhere you like. We have a Docker Compose file that can help you get started with CloudBoost in few minutes and with just one command. You can use this compose file to install the service locally on your local dev machine, or you can install the service to Azure, AWS, DigitalOcean, Softlayer, Packet and more.
[Check out our Docker Compose file here.](https://github.com/CloudBoost/docker)
## Running the server without Docker
**Important:** Before you begin you need to install MongoDB 3.4 and Redis 3.0 on your machine to run this project.
### Step 1 : Git clone the project.
`git clone https://github.com/CloudBoost/cloudboost.git`
### Step 2 : Change directory to CloudBoost.
`cd cloudboost`
### Step 3 : NPM Install.
`npm install`
Note : NPM requires NodeJS to be installed on your machine. If you don't have NodeJS, you need to install it from here : https://nodejs.org/en/download/
### Step 4 : Edit cloudboost.json.
Create a `config` folder in project root if it does not exist. You need to create a new file `cloudboost.json` under `config` folder and save that file with MongoDB and Redis configuration. Here's a sample file :
```
{
"mongo" : [{
"host" : "localhost",
"port" : "27017"
}],
"redis" : [{
"host" : "127.0.0.1",
"port" : 6379
}]
}
```
### Step 5 : Edit smtp.json.
In the `config` folder. Creare a new file called `smtp.json`. You need to create an account at MailGun (https://www.mailgun.com/) and get an API Key. This will help CloudBoost to send emails on your behalf. Here's a quick example :
```
{
"provider" : "mailgun",
"apiKey" : "XXXXXXXXXXXXXXXXXXXXXXX",
"domain" : "cloudboost.io",
"fromEmail" : "[email protected]",
"fromName" : "CloudBoost.io"
}
```
### Step 6 : Enable HTTPS. (Optional)
If you want to enable HTTPS, place your certificate file `cert.crt` and key `key.key` in the config folder.
### Step 7 : Run the server.
Make sure both Redis and MongoDB are running and then run the CloudBoost server
`node server.js`
Once the server is running. You'll see the ClusterKey and SecureKey on the console which means you've successfully started CloudBoost. If you don't see any of these keys, please raise a GitHub issue and let us know.
## Once the server is running, You can
Once started, you'll see the CloudBoost Secure Key on the console. This is important, Please save it for future use.
Secure Key helps you create / delete apps.
### Create an app
To create an app, You need to :
```
REQUEST TYPE : POST
URL : /app/
REQUEST BODY :
{
secureKey : YOUR_SECURE_KEY
}
```
For Example (in curl) :
```
curl -H "Content-Type: application/json" -X POST -d '{"secureKey":"xxxxxx-yyyy-xxxx-yyyyy-xxx"}' http://localhost:4730/app/app1
```
### Creating a table
Table lets you store any structured data in your app. To create one, [check this documentation out](https://tutorials.cloudboost.io/en/schema/cloudtables).
### Delete an app
To delete an app, You need to :
```
REQUEST TYPE : DELETE
URL : /app/
REQUEST BODY :
{
secureKey : YOUR_SECURE_KEY
}
```
For Example (in curl) :
```
curl -H "Content-Type: application/json" -X DELETE -d '{"secureKey":"xxxxxx-yyyy-xxxx-yyyyy-xxx"}' http://localhost:4730/app/app1
```
Once your app is ready, You can then get the latest SDK from https://tutorials.cloudboost.io. Remember to save the SDK in your project. and You can then init your app by :
`CB.CloudApp.init('Your Server URL', 'Your App ID', 'Your App Key');`
You can then follow rest of the documentation from https://tutorials.cloudboost.io. You can also check out API Reference on https://docs.cloudboost.io
## JavaScript SDK
JavaScript SDK can be found in the `sdk` folder of this repo.
### NPM Installation
```
npm install cloudboost
```
### NodeJS Usage
``` js
var CB = require('cloudboost');
```
### Bower Installation
```
bower install cloudboost
```
### JavaScript Usage
``` js
```
### Module Bundlers
``` js
// For ES6/ES7 , TypeScript(typings included)
import * as CB from 'cloudboost';
//For ES5 (requireJs)
var CB = require('cloudboost');
```
### Sample Code
``` js
// AppID and AppKey are your App ID and key of the application created in CloudBoost Dashboard.
//Init your Application
CB.CloudApp.init('YourAppId','YourAppKey');
//Data Storage : Create a CloudObject of type 'Custom' (Note: You need to create a table 'Custom' on CloudBoost Dashboard)
var obj = new CB.CloudObject('Custom');
//Set the property 'name' (Note: Create a column 'name' of type text on CloudBoost Dashboard)
obj.set('name','CloudBoost');
//Save the object
obj.save({
success:function(res){
console.log("object saved successfully");
},
error:function(err){
console.log("error while saving object");
}
});
```
## Cluster Maintenance, Scale, and Updates
CloudBoost runs on MongoDB and Redis. You're responsible for managing the [uptime](https://en.wikipedia.org/wiki/Uptime), [replication](https://en.wikipedia.org/wiki/Replication_(computing)), [sharding](https://en.wikipedia.org/wiki/Shard_(database_architecture)), [backups](https://en.wikipedia.org/wiki/Backup) of your data in each of these databases.
You also need to update CloudBoost with every [new release](https://github.com/cloudboost/cloudboost/releases) and you need to [configure your server to auto-scale it](https://www.brianchristner.io/how-to-scale-a-docker-container-with-docker-compose/). If you're using Docker, the image is released at the `latest` tag and you need to check for new releases atleast once a month.
[Using our hosted and managed service](https://www.cloudboost.io) helps you to save time, development costs, and eliminates managing your own cluster of servers which is cheaper long-term. We recommend using the hosted service if you're running production apps.
## App Settings
To read more about app settings, check [Click here](https://github.com/CloudBoost/cloudboost/tree/master/docs/app-settings)
# Support
- Report bugs and feature requests on [GitHub issue tracker](https://github.com/CloudBoost/cloudboost/issues).
- You can reach out to us on [Slack](https://slack.cloudboost.io). All of our engineers hangout here.
- [StackOverflow](//stackoverflow.com/questions/tagged/cloudboost) : Tag your questions with `cloudboost` tag, so that we're notified.
- Email: [[email protected]](mailto:[email protected])
- Twitter: [@cloudboostio](https://twitter.com/cloudboostio)
# Contributing
[Pull requests](https://help.github.com/articles/about-pull-requests/) are very welcome!
We'd love to hear your feedback and suggestions in the [issue tracker](https://github.com/CloudBoost/cloudboost/issues).
# LICENSE
Copyright 2020 HackerBay, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.