joe/kami-parse-server
Public Access
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: correct README following markdown rules (#8024)

Browse Source
This commit is contained in:
Jeff Gu Kang
2022-06-03 20:26:42 +09:00
committed by GitHub
parent 5e15864dc9
commit a2491ff036
1 changed files with 9 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -111,6 +111,7 @@ Before you start make sure you have installed:
### Compatibility ### Compatibility
#### Node.js #### Node.js
Parse Server is continuously tested with the most recent releases of Node.js to ensure compatibility. We follow the [Node.js Long Term Support plan](https://github.com/nodejs/Release) and only test against versions that are officially supported and have not reached their end-of-life date. Parse Server is continuously tested with the most recent releases of Node.js to ensure compatibility. We follow the [Node.js Long Term Support plan](https://github.com/nodejs/Release) and only test against versions that are officially supported and have not reached their end-of-life date.
| Version | Latest Version | End-of-Life | Compatible | | Version | Latest Version | End-of-Life | Compatible |
@@ -122,6 +123,7 @@ Parse Server is continuously tested with the most recent releases of Node.js to
| Node.js 18 | 18.1.0 | April 2025 | ✅ Yes | | Node.js 18 | 18.1.0 | April 2025 | ✅ Yes |
#### MongoDB #### MongoDB
Parse Server is continuously tested with the most recent releases of MongoDB to ensure compatibility. We follow the [MongoDB support schedule](https://www.mongodb.com/support-policy) and only test against versions that are officially supported and have not reached their end-of-life date. Parse Server is continuously tested with the most recent releases of MongoDB to ensure compatibility. We follow the [MongoDB support schedule](https://www.mongodb.com/support-policy) and only test against versions that are officially supported and have not reached their end-of-life date.
| Version | Latest Version | End-of-Life | Compatible | | Version | Latest Version | End-of-Life | Compatible |
@@ -134,6 +136,7 @@ Parse Server is continuously tested with the most recent releases of MongoDB to
| MongoDB 5.2 | 5.2.1 | TBD | ✅ Yes | | MongoDB 5.2 | 5.2.1 | TBD | ✅ Yes |
#### PostgreSQL #### PostgreSQL
Parse Server is continuously tested with the most recent releases of PostgreSQL and PostGIS to ensure compatibility, using [PostGIS docker images](https://registry.hub.docker.com/r/postgis/postgis/tags?page=1&ordering=last_updated). We follow the [PostgreSQL support schedule](https://www.postgresql.org/support/versioning) and [PostGIS support schedule](https://www.postgis.net/eol_policy/) and only test against versions that are officially supported and have not reached their end-of-life date. Due to the extensive PostgreSQL support duration of 5 years, Parse Server drops support if a version is older than 3.5 years and a newer version has been available for at least 2.5 years. Parse Server is continuously tested with the most recent releases of PostgreSQL and PostGIS to ensure compatibility, using [PostGIS docker images](https://registry.hub.docker.com/r/postgis/postgis/tags?page=1&ordering=last_updated). We follow the [PostgreSQL support schedule](https://www.postgresql.org/support/versioning) and [PostGIS support schedule](https://www.postgis.net/eol_policy/) and only test against versions that are officially supported and have not reached their end-of-life date. Due to the extensive PostgreSQL support duration of 5 years, Parse Server drops support if a version is older than 3.5 years and a newer version has been available for at least 2.5 years.
| Version | PostGIS Version | End-of-Life | Parse Server Support End | Compatible | | Version | PostGIS Version | End-of-Life | Parse Server Support End | Compatible |
@@ -144,6 +147,7 @@ Parse Server is continuously tested with the most recent releases of PostgreSQL
| Postgres 14 | 3.2 | November 2026 | April 2025 | ✅ Yes | | Postgres 14 | 3.2 | November 2026 | April 2025 | ✅ Yes |
### Locally ### Locally
```bash ```bash
$ npm install -g parse-server mongodb-runner $ npm install -g parse-server mongodb-runner
$ mongodb-runner start $ mongodb-runner start
@@ -236,7 +240,6 @@ $ curl -X GET \
} }
] ]
} }
``` ```
To learn more about using saving and querying objects on Parse Server, check out the [Parse documentation](http://docs.parseplatform.org). To learn more about using saving and querying objects on Parse Server, check out the [Parse documentation](http://docs.parseplatform.org).
@@ -386,6 +389,7 @@ const server = ParseServer({
``` ```
## Custom Routes ## Custom Routes
**Caution, this is an experimental feature that may not be appropriate for production.** **Caution, this is an experimental feature that may not be appropriate for production.**
Custom routes allow to build user flows with webpages, similar to the existing password reset and email verification features. Custom routes are defined with the `pages` option in the Parse Server configuration: Custom routes allow to build user flows with webpages, similar to the existing password reset and email verification features. Custom routes are defined with the `pages` option in the Parse Server configuration:
@@ -418,6 +422,7 @@ The above route can be invoked by sending a `GET` request to:
The `handler` receives the `request` and returns a `custom_page.html` webpage from the `pages.pagesPath` directory as response. The advantage of building a custom route this way is that it automatically makes use of Parse Server's built-in capabilities, such as [page localization](#pages) and [dynamic placeholders](#dynamic-placeholders). The `handler` receives the `request` and returns a `custom_page.html` webpage from the `pages.pagesPath` directory as response. The advantage of building a custom route this way is that it automatically makes use of Parse Server's built-in capabilities, such as [page localization](#pages) and [dynamic placeholders](#dynamic-placeholders).
### Reserved Paths ### Reserved Paths
The following paths are already used by Parse Server's built-in features and are therefore not available for custom routes. Custom routes with an identical combination of `path` and `method` are ignored. The following paths are already used by Parse Server's built-in features and are therefore not available for custom routes. Custom routes with an identical combination of `path` and `method` are ignored.
| Path | HTTP Method | Feature | | Path | HTTP Method | Feature |
@@ -513,6 +518,7 @@ Identical requests are identified by their request header `X-Parse-Request-Id`.
Deduplication is only done for object creation and update (`POST` and `PUT` requests). Deduplication is not done for object finding and deletion (`GET` and `DELETE` requests), as these operations are already idempotent by definition. Deduplication is only done for object creation and update (`POST` and `PUT` requests). Deduplication is not done for object finding and deletion (`GET` and `DELETE` requests), as these operations are already idempotent by definition.
### Configuration example <!-- omit in toc --> ### Configuration example <!-- omit in toc -->
``` ```
let api = new ParseServer({ let api = new ParseServer({
idempotencyOptions: { idempotencyOptions: {
@@ -521,6 +527,7 @@ let api = new ParseServer({
} }
} }
``` ```
### Parameters <!-- omit in toc --> ### Parameters <!-- omit in toc -->
| Parameter | Optional | Type | Default value | Example values | Environment variable | Description | | Parameter | Optional | Type | Default value | Example values | Environment variable | Description |
@@ -553,6 +560,7 @@ Assuming the script above is named, `parse_idempotency_delete_expired_records.sh
## Localization ## Localization
### Pages ### Pages
**Caution, this is an experimental feature that may not be appropriate for production.** **Caution, this is an experimental feature that may not be appropriate for production.**
Custom pages as well as feature pages (e.g. password reset, email verification) can be localized with the `pages` option in the Parse Server configuration: Custom pages as well as feature pages (e.g. password reset, email verification) can be localized with the `pages` option in the Parse Server configuration: