parse-server-example

Example project using the parse-server module on Express.

Read the full Parse Server guide here: https://github.com/ParsePlatform/parse-server/wiki/Parse-Server-Guide

For Local Development

• Make sure you have at least Node 4.3. node --version
• Clone this repo and change directory to it.
• npm install
• Install mongo locally using http://docs.mongodb.org/master/tutorial/install-mongodb-on-os-x/
• Run mongo to connect to your database, just to make sure it's working. Once you see a mongo prompt, exit with Control-D
• Uses dotenv to load environment variables: cp .env-example .env, then edit .env to include your Parse AppId, MasterKey and your CleverTap Account ID and CleverTap Account Passcode.
• Run the server with: npm start
• By default it will use a path of /parse for the API routes. To change this, or use older client SDKs, run export PARSE_MOUNT=/1 before launching the server.
• You now have a database named "dev" that contains your Parse data
• Install ngrok and you can test with devices

Usage With CleverTap Push Notifications

• The CleverTap Node.js module will be installed during npm install. You can use it in your cloud code (cloud/main.js) to send push like this:

const CleverTap = require("clevertap");
const clevertap = CleverTap.init(process.env.CLEVERTAP_ACCOUNT_ID, process.env.CLEVERTAP_ACCOUNT_PASSCODE);

Parse.Cloud.define('push', function(req, res) {
    
    /**
     * Send an immediate push to users subscribed to the specified channels
     *
     */

    const channels = req.params.channels;

    if (!channels) {
        res.error("channels not present");
        return;
    }

    const payload = {
        "name": "test push " + Math.round(new Date().getTime()/1000),
        "when": "now",
        "where": {
            "common_profile_prop": {
                "profile_fields": [{"name": "channels", "value": channels}]
            }
        },
        "content": {
            "title":"Hello!",
            "body":"Just testing"
        },
        "devices": ["ios", "android"]
    }

    clevertap.targets(clevertap.TARGET_CREATE, payload, {"debug":1}).then((r) => {
        res.success(r);
    });
});

Parse.Cloud.afterSave('GameScore', function(req) {
    /**
     * Send all users an immediate push notifiying them of a new Game Score. 
     *
     */

    const gameScore = req.object;
    const body = (gameScore) ? `New Game Score: ${gameScore.get("playerName")} ${gameScore.get("score")}` : "New Game Score";
    const payload = {
        "name": "test push " + Math.round(new Date().getTime()/1000),
        "when": "now",
        "segment":"all",
        "content": {
            "title": "Hey There!",
            "body": body,
        },
        "devices": ["ios", "android"]
    }

    clevertap.targets(clevertap.TARGET_CREATE, payload, {"debug":1}).then((r) => {
        console.log(r);
    });
});

Learn more about getting started with CleverTap Push Notifications here.

Getting Started With Heroku + Mongolab Development

With the Heroku Button

Without It

• Clone the repo and change directory to it
• Log in with the Heroku Toolbelt and create an app: heroku create
• Use the MongoLab addon: heroku addons:create mongolab:sandbox
• By default it will use a path of /parse for the API routes. To change this, or use older client SDKs, run heroku config:set PARSE_MOUNT=/1
• Deploy it with: git push heroku master

Getting Started With AWS Elastic Beanstalk

With the Deploy to AWS Button

Without It

• Clone the repo and change directory to it
• Log in with the AWS Elastic Beanstalk CLI, select a region, and create an app: eb init
• Create an environment and pass in MongoDB URI, App ID, and Master Key: eb create --envvars DATABASE_URI=<replace with URI>,APP_ID=<replace with Parse app ID>,MASTER_KEY=<replace with Parse master key>

Getting Started With Microsoft Azure App Service

With the Deploy to Azure Button

Without It

A detailed tutorial is available here: Azure welcomes Parse developers

Getting Started With Google App Engine

1. Clone the repo and change directory to it
2. Create a project in the Google Cloud Platform Console.
3. Enable billing for your project.
4. Install the Google Cloud SDK.
5. Setup a MongoDB server. You have a few options:
6. Create a Google Compute Engine virtual machine with MongoDB pre-installed.
7. Use MongoLab to create a free MongoDB deployment on Google Cloud Platform.
8. Modify app.yaml to update your environment variables.
9. Delete Dockerfile
10. Deploy it with gcloud preview app deploy

A detailed tutorial is available here: Running Parse server on Google App Engine

Getting Started With Scalingo

With the Scalingo button

Without it

• Clone the repo and change directory to it
• Log in with the Scalingo CLI and create an app: scalingo create my-parse
• Use the Scalingo MongoDB addon: scalingo addons-add scalingo-mongodb free
• Setup MongoDB connection string: scalingo env-set DATABASE_URI='$SCALINGO_MONGO_URL'
• By default it will use a path of /parse for the API routes. To change this, or use older client SDKs, run scalingo env-set PARSE_MOUNT=/1
• Deploy it with: git push scalingo master

Using it

Before using it, you can access a test page to verify if the basic setup is working fine http://localhost:1337/test. Then you can use the REST API, the JavaScript SDK, and any of our open-source SDKs:

Example request to a server running locally:

curl -X POST \
  -H "X-Parse-Application-Id: myAppId" \
  -H "Content-Type: application/json" \
  -d '{"score":1337,"playerName":"Sean Plott","cheatMode":false}' \
  http://localhost:1337/parse/classes/GameScore
  
curl -X POST \
  -H "X-Parse-Application-Id: myAppId" \
  -H "Content-Type: application/json" \
  -d '{}' \
  http://localhost:1337/parse/functions/hello

Example using it via JavaScript:

Parse.initialize('myAppId','unused');
Parse.serverURL = 'https://whatever.herokuapp.com';

var obj = new Parse.Object('GameScore');
obj.set('score',1337);
obj.save().then(function(obj) {
  console.log(obj.toJSON());
  var query = new Parse.Query('GameScore');
  query.get(obj.id).then(function(objAgain) {
    console.log(objAgain.toJSON());
  }, function(err) {console.log(err); });
}, function(err) { console.log(err); });

Example using it on Android:

//in your application class

Parse.initialize(new Parse.Configuration.Builder(getApplicationContext())
  .applicationId("myAppId")
  .clientKey("myClientKey")
  .server("http://myServerUrl/parse/")   // '/' important after 'parse'
  .build());

ParseObject testObject = new ParseObject("TestObject");
testObject.put("foo", "bar");
testObject.saveInBackground();

Example using it on iOS (Swift):

//in your AppDelegate

Parse.initializeWithConfiguration(ParseClientConfiguration(block: { (configuration: ParseMutableClientConfiguration) -> Void in
  configuration.server = "https://<# Your Server URL #>/parse/" // '/' important after 'parse'
  configuration.applicationId = "<# Your APP_ID #>"
  configuration.clientKey = "<# Your CLIENT_KEY #>"
}))

You can change the server URL in all of the open-source SDKs, but we're releasing new builds which provide initialization time configuration of this property.