mirror of
https://github.com/stack-auth/stack.git
synced 2026-06-04 21:04:37 +08:00
updated readme
Some checks failed
Runs E2E API Tests / build (20.x) (push) Has been cancelled
Runs E2E API Tests / build (22.x) (push) Has been cancelled
Lint & build / lint_and_build (20.x) (push) Has been cancelled
Lint & build / lint_and_build (22.x) (push) Has been cancelled
TOC Generator / TOC Generator (push) Has been cancelled
Some checks failed
Runs E2E API Tests / build (20.x) (push) Has been cancelled
Runs E2E API Tests / build (22.x) (push) Has been cancelled
Lint & build / lint_and_build (20.x) (push) Has been cancelled
Lint & build / lint_and_build (22.x) (push) Has been cancelled
TOC Generator / TOC Generator (push) Has been cancelled
This commit is contained in:
parent
92f7b60ec6
commit
3844d0a1cb
14
README.md
14
README.md
@ -74,7 +74,19 @@ To get notified first when we add new features, please subscribe to [our newslet
|
||||
|
||||
## 📦 Installation & Setup
|
||||
|
||||
Refer to [our documentation](https://docs.stack-auth.com/getting-started/setup) on how to set up Stack Auth in your Next.js project.
|
||||
1. Run Stack’s installation wizard with the following command:
|
||||
```bash
|
||||
npx @stackframe/init-stack@latest
|
||||
```
|
||||
2. Then, create an account on the [Stack Auth dashboard](https://app.stack-auth.com/projects), 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>
|
||||
```
|
||||
3. That's it! You can run your app with `npm run dev` and go to [http://localhost:3000/handler/signup](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](http://localhost:3000/handler/account-settings).
|
||||
|
||||
Check out the [documentation](https://docs.stack-auth.com/getting-started/setup) for a more detailed guide.
|
||||
|
||||
## 🌱 Some community projects built with Stack
|
||||
|
||||
|
||||
@ -20,7 +20,7 @@ We recommend using our **setup wizard**, which will automatically detect your pr
|
||||
```
|
||||
|
||||
### Update API keys
|
||||
Then, you must create an account on [our dashboard](https://app.stack-auth.com/projects), create a new project with an API key, and copy its environment variables into the `.env.local` file of your Next.js project:
|
||||
Then, create an account on [the Stack Auth dashboard](https://app.stack-auth.com/projects), create a new project with an API key, and copy its environment variables into the `.env.local` file of your Next.js project:
|
||||
|
||||
```sh title=".env.local"
|
||||
NEXT_PUBLIC_STACK_PROJECT_ID=<your-project-id>
|
||||
|
||||
@ -1,29 +1,26 @@
|
||||
# Stack
|
||||
# Stack Auth: Open-source Clerk/Auth0 alternative
|
||||
|
||||
Stack is an open-source, self-hostable, and highly customizable authentication and user management system.
|
||||
## [📘 Docs](https://docs.stack-auth.com) | [☁️ Hosted Version](https://stack-auth.com/) | [✨ Demo](https://demo.stack-auth.com/) | [🎮 Discord](https://discord.stack-auth.com) | [GitHub](https://github.com/stack-auth/stack)
|
||||
|
||||
We provide frontend and backend libraries for Next.js, React, and JavaScript. You can set it up in one minute and scale with the project as it grows.
|
||||
Stack Auth is a managed user authentication solution. It is developer-friendly and fully open-source (licensed under MIT and AGPL).
|
||||
|
||||
## Features
|
||||
Stack 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.
|
||||
|
||||
- Composable React components & hooks
|
||||
- OAuth (Google, Facebook, GitHub, etc.)
|
||||
- Email and password authentication (with email verification and password reset)
|
||||
- Easy to set up with proxied providers (no need to sign up and create OAuth endpoints yourself on all the providers)
|
||||
- User management & analytics
|
||||
- User-associated metadata with client-/server-specific permissions
|
||||
- Out-of-the-box Dark/Light mode support
|
||||
- suports switching out the underlying UI library, support MUI Joy out of the box
|
||||
- **100% open-source!**
|
||||
We support Next.js frontends, along with any backend that can use our [REST API](https://docs.stack-auth.com/rest-api/auth). Check out our [setup guide](https://docs.stack-auth.com/getting-started/setup) to get started.
|
||||
|
||||
Currently, only Next.js is supported, but we are working on adding other frameworks.
|
||||
## 📦 Installation & Setup
|
||||
|
||||
## Installation
|
||||
1. Run Stack’s installation wizard with the following command:
|
||||
```bash
|
||||
npx @stackframe/init-stack@latest
|
||||
```
|
||||
2. Then, create an account on the [Stack Auth dashboard](https://app.stack-auth.com/projects), 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>
|
||||
```
|
||||
3. That's it! You can run your app with `npm run dev` and go to [http://localhost:3000/handler/signup](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](http://localhost:3000/handler/account-settings).
|
||||
|
||||
To get started with Stack, you need to [create a Next.js project](https://nextjs.org/docs/getting-started/installation) using the App router. Then, you can install Stack by running the following command:
|
||||
|
||||
```bash
|
||||
npm install @stackframe/stack
|
||||
```
|
||||
|
||||
For setup, refer to [our documentation](https://docs.stack-auth.com).
|
||||
Check out the [documentation](https://docs.stack-auth.com/getting-started/setup) for a more detailed guide.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user