Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 0 additions & 9 deletions .ebextensions/app.config

This file was deleted.

2 changes: 2 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ RUN npm install
ENV APP_ID setYourAppId
ENV MASTER_KEY setYourMasterKey
ENV SERVER_URL setYourParseServerUrl
ENV USERNAME setYourUsername
ENV PASSWORD setYourPassword

# Optional
# ENV APP_NAME setFriendlyAppName
Expand Down
89 changes: 18 additions & 71 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,19 @@ Example project using the [parse-dashboard](https://github.com/ParsePlatform/par

### For Local Development

* Make sure you have at least Node 4.3. `node --version`
* Clone this repo and change directory to it.
* `npm install`
* Prerequisite: Ensure you have the parse-server installed and working
* Check the parse-server-example project for a quick start: https://github.com/ParsePlatform/parse-server-example
* Run the server with: npm start
- Make sure you have at least Node 4.3. `node --version`
- Clone this repo and change directory to it.
- `npm install`
- Prerequisite: Ensure you have the parse-server installed and working
- Check the parse-server-example project for a quick start: https://github.com/ParsePlatform/parse-server-example
- Run the server with: npm start

### Using it

After starting the dashboard, you can visit http://localhost:4040 in your browser

### Usage

Parse Dashboard can be mounted on an Express app. Express is a web framework for Node.js. The fastest way to get started is to clone the [Parse Dashboard repo](https://github.com/ParsePlatform/parse-dashboard), which at its root contains a sample Express app with the Parse Dashboard API mounted.

The constructor returns an API object that conforms to an [Express Middleware](http://expressjs.com/en/api.html#app.use). This object provides the REST endpoints for a Parse Dashboard app. Create an instance like so:
Expand Down Expand Up @@ -47,77 +48,23 @@ httpServer.listen(port, function() {
});
```

* More configuration options can be found at: [Configuring Parse Dashboard](https://github.com/ParsePlatform/parse-dashboard#configuring-parse-dashboard)
- More configuration options can be found at: [Configuring Parse Dashboard](https://github.com/ParsePlatform/parse-dashboard#configuring-parse-dashboard)

### Getting Started With Heroku Development

#### Using Heroku CLI

* Clone the repo and change directory to it
* Log in with the [Heroku Toolbelt](https://toolbelt.heroku.com/) and create an app: `heroku create`
* Deploy it with: `git push heroku master`
* Open the Heroku dashboard->settings page for your app at: https://dashboard.heroku.com/apps/`<your app name>`/settings
* Click on `Reveal Config Vars` button on the Heroku settings page
* Add the following `Config Vars`. Set them to the values for your `parse-server`
* APP_ID
* MASTER_KEY
* SERVER_URL
* APP_NAME
- Clone the repo and change directory to it
- Log in with the [Heroku Toolbelt](https://toolbelt.heroku.com/) and create an app: `heroku create`
- Deploy it with: `git push heroku master`
- Open the Heroku dashboard->settings page for your app at: https://dashboard.heroku.com/apps/`<your app name>`/settings
- Click on `Reveal Config Vars` button on the Heroku settings page
- Add the following `Config Vars`. Set them to the values for your `parse-server`
- APP_ID
- MASTER_KEY
- SERVER_URL
- APP_NAME

#### With the Heroku Button

[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy)


### Getting Started With AWS Elastic Beanstalk

#### With the Deploy to AWS Button

* HELP WANTED - Need someone to help document this step

#### Without It

* Clone the repo and change directory to it
* Log in with the [AWS Elastic Beanstalk CLI](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/eb-cli3-install.html), select a region, and create an app: `eb init`
* Create an environment and pass in App ID, Master Key, serverURL and appName (optional): `eb create --envvars APP_ID=<replace with Parse app ID>, MASTER_KEY=<replace with Parse master key>, SERVER_URL=<replace with your parse server URL>, APP_NAME=<replace with an optional appname>`

### Getting Started With Microsoft Azure App Service

#### With the Deploy to Azure Button

[![Deploy to Azure](http://azuredeploy.net/deploybutton.png)](https://azuredeploy.net/)

#### Without It

A detailed tutorial is available here:
* HELP WANTED - Need someone to help document the step below correctly
[Azure welcomes Parse developers](https://azure.microsoft.com/en-us/blog/azure-welcomes-parse-developers/)


### Getting Started With Google App Engine

1. Clone the repo and change directory to it
1. Create a project in the [Google Cloud Platform Console](https://console.cloud.google.com/).
1. [Enable billing](https://console.cloud.google.com/project/_/settings) for your project.
1. Install the [Google Cloud SDK](https://cloud.google.com/sdk/).
1. Modify `app.yaml` to update your environment variables.
1. Delete `Dockerfile`
1. Deploy it with `gcloud preview app deploy`

A detailed tutorial is available here:
* HELP WANTED - Need someone to help document the step below correctly
[Running Parse Dashboard server on Google App Engine](https://cloud.google.com/nodejs/resources/frameworks/parse-server)

### Getting Started With Scalingo

#### With the Scalingo button

[![Deploy to Scalingo](https://cdn.scalingo.com/deploy/button.svg)](https://my.scalingo.com/deploy)

#### Without it

* HELP WANTED - Need someone to help document the 3 steps below correctly

* Clone the repo and change directory to it
* Log in with the [Scalingo CLI](http://cli.scalingo.com/) and create an app: `scalingo create my-parse-dashboard`
* Deploy it with: `git push scalingo master`
5 changes: 2 additions & 3 deletions app.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
{
"name": "Parse Dashboard Example",
"description": "An example Parse Dashboard server using the parse-dashboard module",
"repository": "https://github.com/cherukumilli/parse-dashboard-example",
"logo": "https://avatars2.githubusercontent.com/u/5217007?v=3&u=52845c74db401e9fc5df5673460f4d6835a6118a&s=200",
"repository": "https://github.com/louis70109/parse-dashboard-example",
"keywords": ["node", "express", "parse", "dashboard"],
"env": {
"APP_ID": {
Expand All @@ -23,7 +22,7 @@
},
"USERNAME": {
"description": "The username of the account to log into the dashboard.",
"value": "stefanayala3266@gmail.com"
"value": "example@gmail.com"
},
"PASSWORD": {
"description": "The password of the account to log into your dashboard.",
Expand Down
9 changes: 0 additions & 9 deletions app.yaml

This file was deleted.

139 changes: 0 additions & 139 deletions azuredeploy.json

This file was deleted.

4 changes: 2 additions & 2 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

var express = require('express');
var ParseDashboard = require('parse-dashboard');
var path = require('path');

let localParseServer = 'http://localhost:1337/parse';
// Heroku requires HTTPS. Please read the README file for details.
let herokuParseServer = 'https://my-parse-dashboard.herokuapp.com/parse';
let allowInsecureHTTP = true;

var dashboard = new ParseDashboard({
apps: [
Expand All @@ -21,7 +21,7 @@ var dashboard = new ParseDashboard({
{ user: process.env.USERNAME, pass: process.env.PASSWORD }
],
trustProxy: 1
});
}, allowInsecureHTTP);

var app = express();
app.enable('trust proxy');
Expand Down
7 changes: 3 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,12 @@
"main": "index.js",
"repository": {
"type": "git",
"url": "https://github.com/cherukumilli/parse-dashboard-example"
"url": "https://github.com/louis70109/parse-dashboard-example"
},
"license": "MIT",
"dependencies": {
"express": "^4.14.1",
"kerberos": "^0.0.x",
"parse-dashboard": "^1.0.24"
"express": "^4.18.1",
"parse-dashboard": "^4.1.4"
},
"scripts": {
"start": "node index.js"
Expand Down
24 changes: 0 additions & 24 deletions scalingo.json

This file was deleted.