mirror of
https://github.com/stack-auth/stack.git
synced 2026-06-04 21:04:37 +08:00
3fe82b68b6
<!--
Make sure you've read the CONTRIBUTING.md guidelines:
https://github.com/stack-auth/stack-auth/blob/dev/CONTRIBUTING.md
-->
<!-- ELLIPSIS_HIDDEN -->
----
> [!IMPORTANT]
> Add Convex integration with new auth helpers, update access token
handling, and include documentation, examples, and tests for the new
features.
>
> - **Features**:
> - Add Convex integration with new auth helpers for Convex clients and
HTTP in `client-app-impl.ts` and `server-app-impl.ts`.
> - Support for Convex context in user APIs and partial user retrieval.
> - Access tokens now include `is_anonymous` for better anonymous
handling in `tokens.tsx`.
> - **Documentation**:
> - Add Convex integration guide in `docs/templates/others/convex.mdx`.
> - Update docs navigation in `docs/docs-platform.yml` and
`docs/templates/meta.json`.
> - **Examples**:
> - Add Convex + Next.js example app in `examples/convex` with auth
wiring, functions, schema, and UI.
> - **Tests**:
> - Add E2E tests for Convex auth flows in `convex.test.ts`.
> - Update JWT payload checks in `backend-helpers.ts` and
`anonymous-comprehensive.test.ts`.
> - **Chores**:
> - Add Convex dependencies in `package.json` files.
> - Update CI steps for example environments in `e2e-api-tests.yaml` and
`e2e-source-of-truth-api-tests.yaml`.
>
> <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 aa0983a8b7. 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
- **New Features**
- Convex integration: auth helpers for Convex clients/HTTP, Convex-aware
user APIs, and partial-user retrieval (token/convex).
- Access tokens now surface is_anonymous for clearer anonymous handling.
- **Documentation**
- Added Convex integration guide and nav entries.
- **Examples**
- New Convex + Next.js example app with auth wiring, backend functions,
schema, and UI.
- **Tests**
- Added E2E tests covering Convex auth flows and JWT payload checks.
- **Chores**
- Added Convex deps, CI env steps, and workspace/test config updates.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
---------
Co-authored-by: Konstantin Wohlwend <n2d4xc@gmail.com>
41 lines
1.4 KiB
Markdown
41 lines
1.4 KiB
Markdown
# Welcome to your Convex + Next.js app
|
|
|
|
This is a [Convex](https://convex.dev/) project created with [`npm create convex`](https://www.npmjs.com/package/create-convex).
|
|
|
|
After the initial setup (<2 minutes) you'll have a working full-stack app using:
|
|
|
|
- Convex as your backend (database, server logic)
|
|
- [React](https://react.dev/) as your frontend (web page interactivity)
|
|
- [Next.js](https://nextjs.org/) for optimized web hosting and page routing
|
|
- [Tailwind](https://tailwindcss.com/) for building great looking accessible UI
|
|
|
|
## Get started
|
|
|
|
If you just cloned this codebase and didn't use `npm create convex`, run:
|
|
|
|
```
|
|
npm install
|
|
npm run dev
|
|
```
|
|
|
|
If you're reading this README on GitHub and want to use this template, run:
|
|
|
|
```
|
|
npm create convex@latest -- -t nextjs
|
|
```
|
|
|
|
## Learn more
|
|
|
|
To learn more about developing your project with Convex, check out:
|
|
|
|
- The [Tour of Convex](https://docs.convex.dev/get-started) for a thorough introduction to Convex principles.
|
|
- The rest of [Convex docs](https://docs.convex.dev/) to learn about all Convex features.
|
|
- [Stack](https://stack.convex.dev/) for in-depth articles on advanced topics.
|
|
|
|
## Join the community
|
|
|
|
Join thousands of developers building full-stack apps with Convex:
|
|
|
|
- Join the [Convex Discord community](https://convex.dev/community) to get help in real-time.
|
|
- Follow [Convex on GitHub](https://github.com/get-convex/), star and contribute to the open-source implementation of Convex.
|