CodeCow/stack
1
0
Fork 0
mirror of https://github.com/stack-auth/stack.git synced 2026-06-04 21:04:37 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Stan Wohlwend 2024-06-20 15:05:57 +02:00
parent f4a8f36668
commit 3cd4d3f176
1 changed files with 22 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
docs/fern/docs/pages/getting-started/overview.mdx
View File

@ -7,7 +7,7 @@ subtitle: Welcome to Stack!
<Card
title="Setup Guide"
icon="fa-regular fa-play"
href="./setup.mdx"
href="../getting-started/setup.mdx"
>
Setup Stack in your project
</Card>
@ -16,14 +16,14 @@ subtitle: Welcome to Stack!
icon="fa-regular fa-file-lines"
href="../sdk/user.mdx"
>
Learn how to use Stack SDKs
Learn how to use Stack's SDKs for Next.js
</Card>
<Card
title="API Reference"
title="REST API Reference"
icon="fa-solid fa-code"
href="/rest-api"
>
Explore Stack REST API
Explore Stack's REST API for frameworks that aren't natively supported yet
</Card>
<Card
title="Discord"
@ -36,38 +36,42 @@ subtitle: Welcome to Stack!
## Why Stack?
You might wonder: "With so many authentication libraries available, why create Stack?"
Authentication is inherently difficult. There are only few things more sensitive than user data, and only few things more difficult than cryptography. It's not surprising that a majority of online businesses struggle to get it right.
The answer is straightforward: **They all suck at developer experience**.
The optimal authentication solution is secure, yet approachable. If a developer has to worry about JWTs, OAuth flows, or password hashing, then we have failed. If an authentication solution uses closed-source, unauditable code for the most critical parts of your application, then we have failed.
As developers, we don't want to be bothered by decisions about using JWT or session tokens, handling token refreshes, or managing user data synchronization with frontend states. **Auth should be a 5 minutes job**, not 5 days. Our focus should be on building the core product.
The truth is; as the authentication services industry, we have collectively failed. It is dominated by proprietary giants with predatory "bait-and-switch" pricing who provide no transparency into their codebase, and a terrible developer experience because they have determined that enterprises are willing to pay more if setting up auth systems is painful.
Stack abstract all these complexities away by deeply integrate into the frontend and backend framework. It offers a simple and intuitive interface, while remains highly flexible, customizable, and powerful.
That's why we built Stack. Integrating secure authentication into your app should be a matter of **5 minutes**, rather than 5 days.
Here is an example. To use the current user, simply call:
At the core of this are deep integrations into frontend and backend frameworks. We give the best developer experience to anyone using our supported tech stacks; at the moment, this is Next.js with Postgres and TypeScript or Python backends. Instead of giving mediocre support for a lot of frameworks, we chose to make a few integrations as excellent as possible before adding new ones (though we do offer a cross-compatible REST API as a fallback).
Here is an example. To retrieve the current user, simply call:
```tsx
export function MyComponent() {
const user = useUser();
const user = useUser({ or: "redirect" });
return <div>{user ? `Hi, ${user.displayName}` : 'You are not logged in'}</div>;
}
```
That's it! You don't need to worry about fetching the user, storing the user data, handling loading states, or refreshing user data. Stack manages all of that for you.
That's it! Stack will either return a User object or redirect the user to the login page.
You can also add a button to change the user's name:
```tsx
<button onClick={async () => await app.update({ displayName: "New Name" })}>
<button onClick={async () => await user.update({ displayName: "New Name" })}>
Change Name
</button>
```
The user data will be updated in both the frontend and backend automatically. The updated user data will also reflect in `MyComponent` as well.
The user data will update in both the frontend and backend automatically. The updated user data will be reflected in all other components on your page as well.
You also get pages and components for authentication flow out-of-the-box. This for example the sign-in page is what you get without writing a single line of code:
You also get pages and components for authentication flow out-of-the-box. This is the sign-in page that you get without writing a single line of code:
![Stack sign up page](../imgs/signup-page.png)
Notably, there's no branding on any of our components. We believe that we should grow by building the best product, not by forcing our brand on your users — but this means that we **rely on you to spread the word about Stack**. If you like what you're reading, we'd love if you could take a second to tell one or two of your friends about us.
If you prefer a fully customized UI, you can use our low-level functions like `signInWithOAuth` or `signInWithCredential` to build your own sign-in page:
```tsx
@ -85,8 +89,10 @@ To manage everything efficiently, there is a powerful admin dashboard:
![Stack dashboard](../imgs/dashboard.png)
Best of all, Stack is **100% open-source**.
Best of all, Stack is **100% open-source**. That means client, server, dashboard, and even this very documentation you're reading right now. Feel free to check out our [GitHub](https://github.com/stack-auth/stack) and open an issue or pull request.
This is just a glimpse of what Stack can do. Stack also handles many other tasks like backend integration, data storage, emails, teams, permissions, and more, which you will learn later in the documentation.
If this sounds interesting, let's get started with setting up Stack in your project!
If this sounds interesting, [get started](../getting-started/setup.mdx) with our interactive setup wizard, or join [our Discord community](https://discord.stack-auth.com) to ask questions and get help from our team.
We're excited to have you on board! 🚀