mirror of https://github.com/stack-auth/stack.git synced 2026-06-13 21:01:21 +08:00

History

BilalG1 b677e3fd74 fix bad docs (#953 ) <!-- Make sure you've read the CONTRIBUTING.md guidelines: https://github.com/stack-auth/stack-auth/blob/dev/CONTRIBUTING.md --> <!-- RECURSEML_SUMMARY:START --> ## High-level PR Summary This PR fixes a documentation error in the Convex integration guide by correcting two incorrect references from `stackServerApp` to `stackClientApp` for the `getConvexClientAuth()` method calls in browser and React environments. The HTTP client example correctly remains using `stackClientApp` as it was already accurate. ⏱️ Estimated Review Time: 5-15 minutes <details> <summary>💡 Review Order Suggestion</summary> \| Order \| File Path \| \|-------\|-----------\| \| 1 \| `docs/templates/others/convex.mdx` \| </details> [![Need help? Join our Discord](https://img.shields.io/badge/Need%20help%3F%20Join%20our%20Discord-5865F2?style=plastic&logo=discord&logoColor=white)](https://discord.gg/n3SsVDAW6U) [![Analyze latest changes](`dd9214fd6f`/?repo_owner=stack-auth&repo_name=stack-auth&pr_number=953) <!-- RECURSEML_SUMMARY:END --> <!-- ELLIPSIS_HIDDEN --> ---- > [!IMPORTANT] > Fixes incorrect method references in Convex integration docs to use `stackClientApp` for browser and React environments. > > - Documentation: > - Corrects method references in `convex.mdx` and `README.md` from `stackServerApp` to `stackClientApp` for `getConvexClientAuth()` in browser and React environments. > - Updates HTTP client example to use `stackClientApp.getConvexHttpClientAuth()` with `tokenStore` parameter. > - Adds a link to a full example on GitHub in `convex.mdx`. > > <sup>This description was created by </sup>[<img alt="Ellipsis" src="https://img.shields.io/badge/Ellipsis-blue?color=175173">](https://www.ellipsis.dev?ref=stack-auth%2Fstack-auth&utm_source=github&utm_medium=referral)<sup> for `2e9c3f0d1e`. You can [customize](https://app.ellipsis.dev/stack-auth/settings/summaries) this summary. It will automatically update as commits are pushed.</sup> ---- <!-- ELLIPSIS_HIDDEN --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - Documentation - Updated Convex authentication examples to use client-side setup for browser, React, and HTTP clients. - Revised example snippets and wording to reflect current client-oriented APIs for auth initialization. - Clarified how to supply a token store for HTTP usage and aligned examples with current best practices. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Konsti Wohlwend <n2d4xc@gmail.com>		2025-10-17 10:29:35 -07:00
..
scripts	Widget playground mobile mode	2025-07-14 20:04:43 -07:00
src	fix bad docs (#953 )	2025-10-17 10:29:35 -07:00
.env	Vanilla JS client library (#408 )	2025-02-08 02:31:03 +01:00
.eslintrc.cjs	tsup for stack-shared (#647 )	2025-04-28 21:26:52 -07:00
.gitignore	Vanilla JS client library (#408 )	2025-02-08 02:31:03 +01:00
CHANGELOG.md	chore: update package versions	2025-10-15 10:56:40 -07:00
components.json	Vanilla JS client library (#408 )	2025-02-08 02:31:03 +01:00
LICENSE	Vanilla JS client library (#408 )	2025-02-08 02:31:03 +01:00
next-env.d.ts	Vanilla JS client library (#408 )	2025-02-08 02:31:03 +01:00
package-template.json	chore: update package versions	2025-10-15 10:56:40 -07:00
package.json	chore: update package versions	2025-10-15 10:56:40 -07:00
postcss.config.js	Vanilla JS client library (#408 )	2025-02-08 02:31:03 +01:00
quetzal.config.json	Vanilla JS client library (#408 )	2025-02-08 02:31:03 +01:00
README.md	Update branding from Stack to Stack Auth in documentation (#504 )	2025-03-04 04:07:54 +01:00
tailwind.config.js	Vanilla JS client library (#408 )	2025-02-08 02:31:03 +01:00
tsconfig.json	In-source unit tests (#429 )	2025-02-14 11:47:52 -08:00
tsup.config.ts	Convex README	2025-10-10 04:27:05 -07:00
vitest.config.ts	In-source unit tests (#429 )	2025-02-14 11:47:52 -08:00

README.md

Stack Auth: Open-source Clerk/Auth0 alternative

📘 Docs | ☁️ Hosted Version | ✨ Demo | 🎮 Discord | GitHub

Stack Auth is a managed user authentication solution. It is developer-friendly and fully open-source (licensed under MIT and AGPL).

Stack Auth gets you started in just five minutes, after which you'll be ready to use all of its features as you grow your project. Our managed service is completely optional and you can export your user data and self-host, for free, at any time.

We support Next.js frontends, along with any backend that can use our REST API. Check out our setup guide to get started.

📦 Installation & Setup

Run Stack Auth's installation wizard with the following command:
```
npx @stackframe/init-stack@latest
```
Then, create an account on the Stack Auth dashboard, create a new project with an API key, and copy its environment variables into the .env.local file of your Next.js project:
```
NEXT_PUBLIC_STACK_PROJECT_ID=<your-project-id>
NEXT_PUBLIC_STACK_PUBLISHABLE_CLIENT_KEY=<your-publishable-client-key>
STACK_SECRET_SERVER_KEY=<your-secret-server-key>
```
That's it! You can run your app with npm run dev and go to http://localhost:3000/handler/signup to see the sign-up page. You can also check out the account settings page at http://localhost:3000/handler/account-settings.

Check out the documentation for a more detailed guide.