Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update users.md #801

Open
wants to merge 1 commit into
base: gh-pages
Choose a base branch
from

Conversation

MichaelJCole
Copy link

Hi, this is based on my experience attempting to use the Parse GraphQL API with a custom Quasar front-end from this guide. I'm using the "customPages" feature which may be different from other users. Parse seems to be a great back-end data provider, and I'm excited to start building features with it!

See also: parse-community/parse-server#7033 and parse-community/parse-server#7028

The REST Guide might benefit from the same documentation. I'm very new to Parse, so edits welcome.
Thank you

Hi, this is based on my experience attempting to use the Parse GraphQL API with a custom Quasar front-end from this guide.  I'm using the "customPages" feature which may be different from other users.  Parse seems to be a great back-end data provider, and I'm excited to start building features with it!

See also: parse-community/parse-server#7033 and parse-community/parse-server#7028

The REST Guide might benefit from the same documentation.
Thank you
@TomWFox TomWFox requested a review from mtrezza December 15, 2020 15:05
Copy link
Contributor

@TomWFox TomWFox left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR!

@@ -301,3 +378,12 @@ mutation sendVerificationEmail {
}
}
```

The emailed verification link will GET the Parse REST API to verify the token is still valid. For example:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The emailed verification link will GET the Parse REST API to verify the token is still valid. For example:
The emailed verification link will GET the Parse REST API to verify the token is still valid. For example:


Parse will then process the token and forward the user's browser to verified or invalid page provided by the Parse server itself.

Optionally, the Parse server can be configured to forward to custom pages with-in your web application: `verifyEmailSuccess` or `customPages.invalidLink`. Please see the "Resetting Passwords" section for an example and links to further documentation.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you also add a link for resetting passwords...

Suggested change
Optionally, the Parse server can be configured to forward to custom pages with-in your web application: `verifyEmailSuccess` or `customPages.invalidLink`. Please see the "Resetting Passwords" section for an example and links to further documentation.
Optionally, the Parse Server can be configured to forward to custom pages within your web application: `verifyEmailSuccess` or `customPages.invalidLink`. Please see the "Resetting Passwords" section for further documentation.

The verification email is automatically sent on sign up; this mutation is useful if the user didn't receive the first email. Again, an email adapter must be configured for this mutation to work.
To use the `sendVerificationEmail` mutation your Parse Server must have an [email adapter configured as described in the Parse Server guide](https://docs.parseplatform.org/parse-server/guide/#welcome-emails-and-email-verification).

When configured, Parse server will automatically send emails on sign up. this mutation will re-send an email with a password reset link if the user didn't receive the first email or the token expired.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
When configured, Parse server will automatically send emails on sign up. this mutation will re-send an email with a password reset link if the user didn't receive the first email or the token expired.
When configured, Parse server will automatically send emails on sign up. This mutation will re-send an email with a password reset link if the user didn't receive the first email or the token expired.


```

The Parse server forwards the browser to: `choosePassword: \`${process.env.APP_PUBLIC_URL}/auth/reset-password\`,` where your web application accepts the user's new password, and crafts a response to the server. For example, using the $axios http library.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The Parse server forwards the browser to: `choosePassword: \`${process.env.APP_PUBLIC_URL}/auth/reset-password\`,` where your web application accepts the user's new password, and crafts a response to the server. For example, using the $axios http library.
The Parse Server forwards the browser to `${process.env.APP_PUBLIC_URL}/auth/reset-password`, where your web application accepts the user's new password, and crafts a response to the server. For example, using the $axios http library.

```
Parse will then forward the user's browser to a password reset page provided (or invalid token page) by the Parse server itself.

Optionally, the Parse server can be configured to forward to a custom page with-in your web application. This is done using the ["customPages" feature](https://parseplatform.org/parse-server/api/master/CustomPagesOptions.html). For example, using Express:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Optionally, the Parse server can be configured to forward to a custom page with-in your web application. This is done using the ["customPages" feature](https://parseplatform.org/parse-server/api/master/CustomPagesOptions.html). For example, using Express:
Optionally, the Parse server can be configured to forward to a custom page with-in your web application. This is done using the ["customPages" feature](https://parseplatform.org/parse-server/api/master/CustomPagesOptions.html). For example, using Express:

@@ -272,9 +274,84 @@ mutation resetPassword {
}
```

The emailed password reset link will GET the Parse REST API to verify the token is still valid. For example:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The emailed password reset link will GET the Parse REST API to verify the token is still valid. For example:
The emailed password reset link will GET the Parse REST API to verify the token is still valid. For example:

https://www.example.com/parse/apps/APP_ID/verify_email?token=xxxxxxxxxxxx&username=test%4example.com
```

Parse will then process the token and forward the user's browser to verified or invalid page provided by the Parse server itself.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Parse will then process the token and forward the user's browser to verified or invalid page provided by the Parse server itself.
Parse will then process the token and forward the user's browser to verified or invalid page provided by the Parse Server itself.

Comment on lines +284 to +307
```
const parseServer = new ParseServer({
// Basics: https://github.com/parse-community/parse-server#basic-options
appId: process.env.PARSE_SERVER_APPLICATION_ID,
...otherOptions

// Email: https://github.com/parse-community/parse-server#email-verification-and-password-reset
verifyUserEmails: true,
emailVerifyTokenValidityDuration: 2 * weekInSeconds,
preventLoginWithUnverifiedEmail: false,

// Emailed links point to this host. It must include `/parse`
publicServerURL: process.env.PARSE_PUBLIC_SERVER_URL || process.env.PARSE_SERVER_URL,
// Your apps name. This will appear in the subject and body of the emails that are sent.
appName: 'Application Name for User',
// The email adapter
emailAdapter: {
module: "parse-server-aws-ses",
options: {
from: `Hello <${process.env.EMAIL_FROM_ADDRESS}>`,
region: process.env.AWS_REGION,
// aws-sdk loads keys from environment variables
}
},
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you remove/comment the non-code text - ...otherOptions etc

@mtrezza
Copy link
Member

mtrezza commented Jul 26, 2021

@MichaelJCole It's been some time, but it would be great if you were still available to help make these changes. Do you have any questions regarding the review?

@mtrezza mtrezza removed their request for review July 26, 2021 20:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants