Skip to content

Commit a254759

Browse files
committed
New introduction and links to the documentation
1 parent 52c4c4b commit a254759

File tree

1 file changed

+27
-8
lines changed

1 file changed

+27
-8
lines changed

README.md

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,36 @@
1-
## parse-server
1+
<img src="http://parse.com/assets/svgs/parse-infinity.svg" alt="Parse logo" height="70"/>
2+
3+
## Parse Server
24

35
[![Build Status](https://img.shields.io/travis/ParsePlatform/parse-server/master.svg?style=flat)](https://travis-ci.org/ParsePlatform/parse-server)
46
[![Coverage Status](https://img.shields.io/codecov/c/github/ParsePlatform/parse-server/master.svg)](https://codecov.io/github/ParsePlatform/parse-server?branch=master)
57
[![npm version](https://img.shields.io/npm/v/parse-server.svg?style=flat)](https://www.npmjs.com/package/parse-server)
68

7-
A Parse.com API compatible router package for Express
9+
Parse Server is an open source version of the Parse backend that can be deployed to any infrastructure that can run Node.js.
10+
11+
Parse Server works with the Express web application framework. It can be added to existing web applications, or run by itself.
812

913
Read the announcement blog post here: http://blog.parse.com/announcements/introducing-parse-server-and-the-database-migration-tool/
1014

11-
Read the migration guide here: https://parse.com/docs/server/guide#migrating
15+
## Documentation
16+
17+
Documentation for Parse Server is available in the [wiki](https://github.com/ParsePlatform/parse-server/wiki) for this repository. The [Parse Server guide](https://github.com/ParsePlatform/parse-server/wiki/Parse-Server-Guide) is a good place to get started.
18+
19+
If you're interested in developing for Parse Server, the [Development guide](https://github.com/ParsePlatform/parse-server/wiki/Development-Guide) will help you get set up.
20+
21+
### Example Project
22+
23+
Check out the [parse-server-example project](https://github.com/ParsePlatform/parse-server-example) repository for an example of a Node.js application that uses the parse-server module on Express.
24+
25+
### Migration Guide
26+
27+
Migrate your existing Parse apps to your own Parse Server. The hosted version of Parse will be fully retired on January 28th, 2017. If you are planning to migrate an app, you need to begin work as soon as possible. Learn more in the [Migration guide](https://github.com/ParsePlatform/parse-server/wiki/Migrating-an-Existing-Parse-App).
1228

13-
There is a development wiki here on GitHub: https://github.com/ParsePlatform/parse-server/wiki
1429

15-
We also have an [example project](https://github.com/ParsePlatform/parse-server-example) using the parse-server module on Express.
1630

1731
---
1832

33+
1934
#### Basic options:
2035

2136
* databaseURI (required) - The connection string for your database, i.e. `mongodb://user:[email protected]/dbname`
@@ -74,7 +89,7 @@ It is possible to leverage the OAuth support with any 3rd party authentication t
7489
7590
oauth: {
7691
my_custom_auth: {
77-
module: "PATH_TO_MODULE" // OR object,
92+
module: "PATH_TO_MODULE" // OR object,
7893
option1: "",
7994
option2: "",
8095
}
@@ -141,12 +156,12 @@ app.listen(port, function() {
141156

142157
You can configure the Parse Server with environment variables:
143158

144-
```js
159+
```js
145160
PARSE_SERVER_DATABASE_URI
146161
PARSE_SERVER_CLOUD_CODE_MAIN
147162
PARSE_SERVER_COLLECTION_PREFIX
148163
PARSE_SERVER_APPLICATION_ID // required
149-
PARSE_SERVER_CLIENT_KEY
164+
PARSE_SERVER_CLIENT_KEY
150165
PARSE_SERVER_REST_API_KEY
151166
PARSE_SERVER_DOTNET_KEY
152167
PARSE_SERVER_JAVASCRIPT_KEY
@@ -192,3 +207,7 @@ You can also set up an app on Parse, providing the connection string for your mo
192207
### Not supported
193208

194209
* `Parse.User.current()` or `Parse.Cloud.useMasterKey()` in cloud code. Instead of `Parse.User.current()` use `request.user` and instead of `Parse.Cloud.useMasterKey()` pass `useMasterKey: true` to each query. To make queries and writes as a specific user within Cloud Code, you need the user's session token, which is available in `request.user.getSessionToken()`.
210+
211+
## Contributing
212+
213+
We really want Parse to be yours, to see it grow and thrive in the open source community. Please see the [Contributing to Parse Server guide](CONTRIBUTING.md).

0 commit comments

Comments
 (0)