diff --git a/README.md b/README.md index 0a7365dd2e..19bf9e6290 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,36 @@ -## parse-server +Parse logo + +## Parse Server [![Build Status](https://img.shields.io/travis/ParsePlatform/parse-server/master.svg?style=flat)](https://travis-ci.org/ParsePlatform/parse-server) [![Coverage Status](https://img.shields.io/codecov/c/github/ParsePlatform/parse-server/master.svg)](https://codecov.io/github/ParsePlatform/parse-server?branch=master) [![npm version](https://img.shields.io/npm/v/parse-server.svg?style=flat)](https://www.npmjs.com/package/parse-server) -A Parse.com API compatible router package for Express +Parse Server is an open source version of the Parse backend that can be deployed to any infrastructure that can run Node.js. + +Parse Server works with the Express web application framework. It can be added to existing web applications, or run by itself. Read the announcement blog post here: http://blog.parse.com/announcements/introducing-parse-server-and-the-database-migration-tool/ -Read the migration guide here: https://parse.com/docs/server/guide#migrating +## Documentation + +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. + +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. + +### Example Project + +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. + +### Migration Guide + +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). -There is a development wiki here on GitHub: https://github.com/ParsePlatform/parse-server/wiki -We also have an [example project](https://github.com/ParsePlatform/parse-server-example) using the parse-server module on Express. --- + #### Basic options: * databaseURI (required) - The connection string for your database, i.e. `mongodb://user:pass@host.com/dbname` @@ -74,7 +89,7 @@ It is possible to leverage the OAuth support with any 3rd party authentication t oauth: { my_custom_auth: { - module: "PATH_TO_MODULE" // OR object, + module: "PATH_TO_MODULE" // OR object, option1: "", option2: "", } @@ -141,12 +156,12 @@ app.listen(port, function() { You can configure the Parse Server with environment variables: -```js +```js PARSE_SERVER_DATABASE_URI PARSE_SERVER_CLOUD_CODE_MAIN PARSE_SERVER_COLLECTION_PREFIX PARSE_SERVER_APPLICATION_ID // required -PARSE_SERVER_CLIENT_KEY +PARSE_SERVER_CLIENT_KEY PARSE_SERVER_REST_API_KEY PARSE_SERVER_DOTNET_KEY PARSE_SERVER_JAVASCRIPT_KEY @@ -192,3 +207,7 @@ You can also set up an app on Parse, providing the connection string for your mo ### Not supported * `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()`. + +## Contributing + +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).