mirror of
https://github.com/stack-auth/stack.git
synced 2026-06-13 21:01:21 +08:00
13fccd32b6
Some checks failed
all-good: Did all the other checks pass? / all-good (push) Has been cancelled
Ensure Prisma migrations are in sync with the schema / check_prisma_migrations (22.x) (push) Has been cancelled
DB migration compat / Check if migrations changed (push) Has been cancelled
Docker Server Build and Push / Docker Build and Push Server (push) Has been cancelled
Docker Server Build and Run / docker (push) Has been cancelled
Runs E2E API Tests (Local Emulator) / E2E Tests (Local Emulator, Node ${{ matrix.node-version }}) (22.x) (push) Has been cancelled
Runs E2E API Tests / E2E Tests (Node ${{ matrix.node-version }}, Freestyle ${{ matrix.freestyle-mode }}) (mock, 22.x) (push) Has been cancelled
Runs E2E API Tests / E2E Tests (Node ${{ matrix.node-version }}, Freestyle ${{ matrix.freestyle-mode }}) (prod, 22.x) (push) Has been cancelled
Runs E2E API Tests with custom port prefix / build (22.x) (push) Has been cancelled
Lint & build / lint_and_build (latest) (push) Has been cancelled
Dev Environment Test With Custom Base Port / restart-dev-and-test-with-custom-base-port (push) Has been cancelled
Dev Environment Test / restart-dev-and-test (push) Has been cancelled
Run setup tests with custom base port / setup-tests-with-custom-base-port (push) Has been cancelled
Run setup tests / setup-tests (push) Has been cancelled
TOC Generator / TOC Generator (push) Has been cancelled
DB migration compat / Back-compat — Current branch migrations with ${{ needs.check-migrations-changed.outputs.base_branch }} branch code (push) Has been cancelled
DB migration compat / Forward-compat — Current branch code with ${{ needs.check-migrations-changed.outputs.base_branch }} branch migrations (push) Has been cancelled
DB migration compat / No migration changes (skipped) (push) Has been cancelled
88 lines
2.4 KiB
Plaintext
88 lines
2.4 KiB
Plaintext
---
|
|
title: Overview
|
|
description: Welcome to Stack Auth - open-source authentication that gets you started in minutes.
|
|
sidebarTitle: Overview
|
|
icon: house
|
|
---
|
|
|
|
# Welcome to Stack Auth
|
|
|
|
Open-source authentication that gets you started in minutes.
|
|
|
|
## Quick Start (Next.js)
|
|
|
|
<Steps>
|
|
<Step title="Install the SDK">
|
|
```bash
|
|
npx @stackframe/stack-cli@latest init
|
|
```
|
|
</Step>
|
|
<Step title="Use authentication">
|
|
```tsx
|
|
const user = useUser({ or: "redirect" });
|
|
return <div>Hi, {user.displayName}</div>;
|
|
```
|
|
</Step>
|
|
</Steps>
|
|
|
|
For other frameworks or detailed configuration, see the [full setup guide](./getting-started/setup).
|
|
|
|
## Components
|
|
|
|
Pre-built UI components ready to use:
|
|
|
|
- [`<SignIn />`](./components/sign-in)
|
|
- [`<SignUp />`](./components/sign-up)
|
|
- [`<UserButton />`](./components/user-button)
|
|
- [`<AccountSettings />`](./components/account-settings)
|
|
- [`<SelectedTeamSwitcher />`](./components/selected-team-switcher)
|
|
- [`<StackHandler />`](./components/stack-handler)
|
|
|
|
[View all components →](./components)
|
|
|
|
## Explore
|
|
|
|
<Columns cols={2}>
|
|
<Card title="Setup & Installation" icon="play" href="./getting-started/setup">
|
|
Get started with Stack in 5 minutes
|
|
</Card>
|
|
<Card title="Components" icon="puzzle-piece" href="./components">
|
|
Pre-built React components for sign-in, user management, and more
|
|
</Card>
|
|
<Card title="SDK Reference" icon="file-lines" href="./sdk">
|
|
Learn how to use Stack Auth's SDK
|
|
</Card>
|
|
<Card title="REST API" icon="code" href="./rest-api/overview">
|
|
Explore Stack's REST APIs
|
|
</Card>
|
|
</Columns>
|
|
|
|
## Apps
|
|
|
|
Enable powerful features through the dashboard:
|
|
|
|
<Columns cols={3}>
|
|
<Card title="API Keys" icon="key" href="./apps/api-keys">
|
|
Manage API keys for your application
|
|
</Card>
|
|
<Card title="Emails" icon="envelope" href="./apps/emails">
|
|
Configure email templates and providers
|
|
</Card>
|
|
<Card title="Teams" icon="users" href="./apps/orgs-and-teams">
|
|
Organize users into teams
|
|
</Card>
|
|
<Card title="Permissions" icon="shield" href="./apps/permissions">
|
|
Role-based access control
|
|
</Card>
|
|
<Card title="Webhooks" icon="webhook" href="./apps/webhooks">
|
|
Set up event-driven webhooks
|
|
</Card>
|
|
<Card title="Analytics" icon="chart-line" href="./apps/analytics">
|
|
Monitor authentication analytics
|
|
</Card>
|
|
</Columns>
|
|
|
|
---
|
|
|
|
Still have questions? Check out our [FAQ](./faq) or [join our Discord](https://discord.stack-auth.com).
|