Skip to content

Commit 2d072a6

Browse files
authored
docs: update README (#419)
1 parent 96b104f commit 2d072a6

File tree

1 file changed

+26
-19
lines changed

1 file changed

+26
-19
lines changed

README.md

Lines changed: 26 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,22 @@
1-
# parse-server-example <!-- omit in toc -->
1+
![parse-repository-header](https://user-images.githubusercontent.com/5673677/169108275-8efa0dae-4997-4ddc-9c12-88a9c4c42e31.png)
2+
3+
---
24

35
[![Join The Conversation](https://img.shields.io/discourse/https/community.parseplatform.org/topics.svg)](https://community.parseplatform.org/c/parse-server)
4-
[![Backers on Open Collective](https://opencollective.com/parse-server/tiers/backers/badge.svg)][open-collective-link]
5-
[![Sponsors on Open Collective](https://opencollective.com/parse-server/tiers/sponsors/badge.svg)][open-collective-link]
6+
[![Backers on Open Collective](https://opencollective.com/parse-server/backers/badge.svg)][open-collective-link]
7+
[![Sponsors on Open Collective](https://opencollective.com/parse-server/sponsors/badge.svg)][open-collective-link]
68
[![License][license-svg]][license-link]
7-
[![Twitter Follow](https://img.shields.io/twitter/follow/ParsePlatform.svg?label=Follow%20us%20on%20Twitter&style=social)](https://twitter.com/intent/follow?screen_name=ParsePlatform)
9+
[![Forum](https://img.shields.io/discourse/https/community.parseplatform.org/topics.svg)](https://community.parseplatform.org/c/parse-server)
10+
[![Twitter](https://img.shields.io/twitter/follow/ParsePlatform.svg?label=Follow&style=social)](https://twitter.com/intent/follow?screen_name=ParsePlatform)
11+
12+
---
13+
14+
This is an example project using the [Parse Server](https://github.com/ParsePlatform/parse-server) module on Express.
15+
816

9-
Example project using the [parse-server](https://github.com/ParsePlatform/parse-server) module on Express. Read the full [Parse Server Guide](https://docs.parseplatform.org/parse-server/guide/) for more information.
17+
The [Parse Server guide](https://docs.parseplatform.org/parse-server/guide/) is a good place to get started. An [API reference](https://parseplatform.org/parse-server/api/) and [Cloud Code guide](https://docs.parseplatform.org/cloudcode/guide/) are also available. If you're interested in developing for Parse Server, the [Development guide](https://docs.parseplatform.org/parse-server/guide/#development-guide) will help you get set up. All documentations for Parse Platform's server and its client SDKs are available at [parseplatform.org](https://parseplatform.org).
1018

11-
# Table of Contents <!-- omit in toc -->
19+
---
1220

1321
- [Local Development](#local-development)
1422
- [Helpful Scripts](#helpful-scripts)
@@ -29,15 +37,14 @@ Example project using the [parse-server](https://github.com/ParsePlatform/parse-
2937

3038
# Local Development
3139

32-
* Make sure you have at least Node 4.3. `node --version`
33-
* Clone this repo and change directory to it.
34-
* `npm install`
35-
* Install mongo locally using http://docs.mongodb.org/master/tutorial/install-mongodb-on-os-x/
36-
* Run `mongo` to connect to your database, just to make sure it's working. Once you see a mongo prompt, exit with Control-D
37-
* Run the server with: `npm start`
38-
* 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.
39-
* You now have a database named "dev" that contains your Parse data
40-
* Install ngrok and you can test with devices
40+
1. Make sure you have a compatible Node.js version installed. Run `node --version` to see your local Node.js version. Open the `package.json` file too see which version of Node.js this example repository requires at `{ engines": { "node": "<NODE_VERSION>" } }`. Note that there may be other Parse Server version available that support older or newer Node.js versions, see the [Parse Server compatibility table](https://github.com/parse-community/parse-server#compatibility).
41+
2. Clone this repository and change directory to it.
42+
3. Run `npm install`.
43+
4. Install a MongoDB database locally from https://docs.mongodb.org/master/tutorial/install-mongodb-on-os-x.
44+
5. Run `mongo` to connect to your database, just to make sure it's working. Once you see a mongo prompt, exit with `Control-D`.
45+
6. Launch Parse Server with `npm start`.
46+
7. By default the API route will use `/parse` as a base. You can change this by setting the environment variable `PARSE_MOUNT`, for example in the CLI run run `export PARSE_MOUNT=/app` to set the path to `app`.
47+
8. Your Parse Server is not running and is connected to your local database named `dev` in which the data is stored that you manage via Parse Server.
4148

4249
## Helpful Scripts
4350
These scripts can help you to develop your app for Parse Server:
@@ -65,7 +72,7 @@ Alternatively, to deploy manually:
6572

6673
## AWS Elastic Beanstalk
6774

68-
<a title="Deploy to AWS" href="https://console.aws.amazon.com/elasticbeanstalk/home?region=us-west-2#/newApplication?applicationName=ParseServer&solutionStackName=Node.js&tierName=WebServer&sourceBundleUrl=https://s3.amazonaws.com/elasticbeanstalk-samples-us-east-1/eb-parse-server-sample/parse-server-example.zip" target="_blank"><img src="http://d0.awsstatic.com/product-marketing/Elastic%20Beanstalk/deploy-to-aws.png" height="40"></a>
75+
<a title="Deploy to AWS" href="https://console.aws.amazon.com/elasticbeanstalk/home?region=us-west-2#/newApplication?applicationName=ParseServer&solutionStackName=Node.js&tierName=WebServer&sourceBundleUrl=https://s3.amazonaws.com/elasticbeanstalk-samples-us-east-1/eb-parse-server-sample/parse-server-example.zip" target="_blank"><img src="https://d0.awsstatic.com/product-marketing/Elastic%20Beanstalk/deploy-to-aws.png" height="40"></a>
6976

7077
Alternatively, deploy your local changes manually:
7178

@@ -75,7 +82,7 @@ Alternatively, deploy your local changes manually:
7582

7683
## Microsoft Azure App Service
7784

78-
[![Deploy to Azure](http://azuredeploy.net/deploybutton.png)](https://portal.azure.com/#create/Microsoft.ParseServer)
85+
[![Deploy to Azure](https://azuredeploy.net/deploybutton.png)](https://portal.azure.com/#create/Microsoft.ParseServer)
7986

8087
Detailed information is available here:
8188
* [Parse Server with Azure Managed Services](https://azure.microsoft.com/en-us/marketplace/partners/microsoft/parseserver/)
@@ -104,15 +111,15 @@ A detailed tutorial is available here:
104111
Alternatively, to deploy manually:
105112

106113
* Clone the repo and change directory to it
107-
* Log in with the [Scalingo CLI](http://cli.scalingo.com/) and create an app: `scalingo create my-parse`
114+
* Log in with the [Scalingo CLI](https://cli.scalingo.com/) and create an app: `scalingo create my-parse`
108115
* Use the [Scalingo MongoDB addon](https://scalingo.com/addons/scalingo-mongodb): `scalingo addons-add scalingo-mongodb free`
109116
* Setup MongoDB connection string: `scalingo env-set DATABASE_URI='$SCALINGO_MONGO_URL'`
110117
* 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`
111118
* Deploy it with: `git push scalingo master`
112119

113120
## OpenShift Online (Next Gen)
114121

115-
1. Register for a free [OpenShift Online (Next Gen) account](http://www.openshift.com/devpreview/register.html)
122+
1. Register for a free [OpenShift Online (Next Gen) account](https://www.openshift.com/devpreview/register.html)
116123
1. Create a project in the [OpenShift Online Console](https://console.preview.openshift.com/console/).
117124
1. Install the [OpenShift CLI](https://docs.openshift.com/online/getting_started/beyond_the_basics.html#btb-installing-the-openshift-cli).
118125
1. Add the Parse Server template to your project: `oc create -f https://raw.githubusercontent.com/ParsePlatform/parse-server-example/master/openshift.json`

0 commit comments

Comments
 (0)