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.

Sign up for GitHub

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

Jump to bottom

update fastify doc and quickstart #1555

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

update fastify doc and quickstart #1555

wants to merge 2 commits into from
+89 −72

Conversation

victoriaxyz
Copy link
Contributor

@victoriaxyz victoriaxyz commented Sep 19, 2024 •
edited
Loading

Important

🔎 Previews:

Explanation:

This PR:

  • refactors the setup instructions
  • updates code examples
  • adds important notes about setup

Notes

  • Updated quickstart, repo name needs to be updated to clerk-fastify-quickstart
  • Unsure if previous starter repo worked since there was no tsconfig.json file to run server
  • Clerk Dashboard > Configure > Quick Copy dropdown does not have a Fastify option
  • Pending access request to Linear Design team, need to make ticket to get Fastify icon for <TutorialHero/>
  • Is it necessary to have a Clerk Fastify doc to show getAuth() method? E.g., Remix
  • Is there a preference for the term routes or pages? Used routes because doc is about backend.
  • Is the ESM note about package.json is necessary?
  • Will need to address this issue in the doc later

@victoriaxyz victoriaxyz requested a review from a team as a code owner September 19, 2024 22:41
@victoriaxyz victoriaxyz mentioned this pull request Sep 19, 2024
Open
victoriaxyz
victoriaxyz commented Sep 19, 2024
View reviewed changes
docs/quickstarts/fastify.mdx
}, {
title: "Add Fastify as your backend",
link: "https://fastify.dev/docs/latest/Guides/Getting-Started",
icon: "fastify",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Pending access to design team on Linear, need to make ticket to request Fastify icon

victoriaxyz
victoriaxyz commented Sep 19, 2024
View reviewed changes
docs/quickstarts/fastify.mdx
Learn how to integrate Clerk into your Fastify backend for secure user authentication and management. This guide uses TypeScript and allows you to choose your frontend framework.

> [!IMPORTANT]
> [Fastify is only compatible with Next.js versions 13.4 and below](https://github.com/fastify/fastify-nextjs). If you're using a newer version of Next.js, consider using a different backend framework that supports the latest Next.js features.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Necessary?

victoriaxyz
victoriaxyz commented Sep 19, 2024
View reviewed changes
docs/quickstarts/fastify.mdx
> [!NOTE]
> If you're looking for a more complete example, check out our [Fastify example app](https://github.com/clerk/clerk-fastify-starter/).
> If you're using ECMAScript Modules (ESM) in your project, you must include `"type": "module"` in your `package.json` to enable ESM support in Node.js.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Necessary?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@victoriaxyz