You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -39,35 +38,43 @@ Parse Server works with the Express web application framework. It can be added t
39
38
40
39
# Getting Started
41
40
42
-
April 2016 - We created a series of video screencasts, please check them out here: [http://blog.parseplatform.org/learn/parse-server-video-series-april-2016/](http://blog.parseplatform.org/learn/parse-server-video-series-april-2016/)
41
+
Parse-Server is built on the top of node. Before you can get started, you should have the latest version of node and npm installed.
42
+
We always recommend you run your server on the LTS versions as we focus on providing the most stability on those versions.
43
43
44
-
The fastest and easiest way to get started is to run MongoDB and Parse Server locally.
44
+
You can find the latest versions of [node.js here](https://nodejs.org/en/).
45
45
46
-
## Running Parse Server
46
+
In order to be fully functional, `parse-server` requires a database to run. You'll need to either have [mongodb](https://www.mongodb.com/download-center) or [postgres](https://www.postgresql.org/download/) setup, locally or remotely.
You can use any arbitrary string as your application id and master key. These will be used by your clients to authenticate with the Parse Server.
64
+
The script above will create a fully functional `parse-server` setup in `my-parse-app` folder with:
65
65
66
-
That's it! You are now running a standalone version of Parse Server on your machine.
66
+
-`package.json`: the nodejs package definition, that defines the dependencies for your project.
67
+
-`cloud`: the folder for your cloud code.
68
+
-`cloud/main.js`: the main entrypoint for cloud code.
69
+
-`public`: the folder for publicly accessible static contents.
67
70
68
-
**Using a remote MongoDB?** Pass the `--databaseURI DATABASE_URI` parameter when starting `parse-server`. Learn more about configuring Parse Server [here](#configuration). For a full list of available options, run `parse-server --help`.
71
+
You can start the server with the following command:
69
72
70
-
### Saving your first object
73
+
```sh
74
+
$ npm start
75
+
```
76
+
77
+
## Saving your first object
71
78
72
79
Now that you're running Parse Server, it is time to save your first object. We'll use the [REST API](http://docs.parseplatform.org/rest/guide), but you can easily do the same using any of the [Parse SDKs](http://parseplatform.org/#sdks). Run the following:
73
80
@@ -133,7 +140,7 @@ $ curl -X GET \
133
140
134
141
To learn more about using saving and querying objects on Parse Server, check out the [Parse documentation](http://docs.parseplatform.org).
135
142
136
-
###Connect your app to Parse Server
143
+
## Connect your app to Parse Server
137
144
138
145
Parse provides SDKs for all the major platforms. Refer to the Parse Server guide to [learn how to connect your app to Parse Server](https://github.com/parse-community/parse-server/wiki/Parse-Server-Guide#using-parse-sdks-with-parse-server).
139
146
@@ -200,6 +207,22 @@ Logs are also be viewable in Parse Dashboard.
200
207
201
208
**Want new line delimited JSON error logs (for consumption by CloudWatch, Google Cloud Logging, etc.)?** Pass the `JSON_LOGS` environment variable when starting `parse-server`. Usage :- `JSON_LOGS='1' parse-server --appId APPLICATION_ID --masterKey MASTER_KEY`
You can use any arbitrary string as your application id and master key. These will be used by your clients to authenticate with the Parse Server.
221
+
222
+
That's it! You are now running a standalone version of Parse Server on your machine.
223
+
224
+
**Using a remote MongoDB?** Pass the `--databaseURI DATABASE_URI` parameter when starting `parse-server`. Learn more about configuring Parse Server [here](#configuration). For a full list of available options, run `parse-server --help`.
225
+
203
226
# Documentation
204
227
205
228
The full documentation for Parse Server is available in the [wiki](https://github.com/parse-community/parse-server/wiki). The [Parse Server guide](http://docs.parseplatform.org/parse-server/guide/) is a good place to get started. If you're interested in developing for Parse Server, the [Development guide](http://docs.parseplatform.org/parse-server/guide/#development-guide) will help you get set up.
0 commit comments