-
- ๐ Docs
- | โ๏ธ Hosted Version
- | โจ Demo
- | ๐ฎ Discord
-
+
+
-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=
- NEXT_PUBLIC_STACK_PUBLISHABLE_CLIENT_KEY=
- STACK_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).
+
-### Templates
-- [Stack Auth Template by Stack Auth Team](https://github.com/hexclave/stack-auth-template)
-- [Next SaaSkit by wolfgunblood](https://github.com/wolfgunblood/nextjs-saaskit)
-- [SaaS Boilerplate by Robin Faraj](https://github.com/robinfaraj/saas-boilerplate)
+
-**Important**: Please read the [contribution guidelines](CONTRIBUTING.md) carefully and join [our Discord](https://discord.stack-auth.com) if you'd like to help.
+
-Note: 24GB+ of RAM is recommended for a smooth development experience.
+
-# Start the dependencies (DB, Inbucket, etc.) as Docker containers, seeding the DB with the Prisma schema
-# Make sure you have Docker (or OrbStack) installed and running
-pnpm restart-deps
+
-Your IDE may show an error on all `@stackframe/XYZ` imports. To fix this, simply restart the TypeScript language server; for example, in VSCode you can open the command palette (Ctrl+Shift+P) and run `Developer: Reload Window` or `TypeScript: Restart TS server`.
+
-# Installation commands
-pnpm install: Installs dependencies
+
-# Environment commands
-pnpm start-deps: Starts the Docker dependencies (DB, Inbucket, etc.) as Docker containers, and initializes them with the seed script & migrations. Note: The started dependencies will be visible on the dev launchpad (port 8100 by default).
-pnpm stop-deps: Stops the Docker dependencies (DB, Inbucket, etc.) and deletes the data on them.
-pnpm restart-deps: Stops and starts the dependencies.
+
+
+## Contributing
-Note: When working with AI, you should keep a terminal tab with the dev server open so the AI can run queries against it.
+Hexclave is open source, and contributions are welcome. Read
+[`CONTRIBUTING.md`](./CONTRIBUTING.md) to get started, and say hello in
+[Discord](https://discord.hexclave.com) before picking up anything large.
+Found a security issue? Email security@hexclave.com.
## โค Contributors
- 
+ 
- ๐ Docs
- | โ๏ธ Hosted Version
- | โจ Demo
- | ๐ฎ Discord
-
+
-# Stack Auth: The open-source auth platform
+
-Stack Auth is a managed user authentication solution. It is developer-friendly and fully open-source (licensed under MIT and AGPL).
+**The user infrastructure platform.**
-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.
+Hexclave handles everything around your users: authentication, teams,
+payments, emails, analytics, and much more. Start in minutes on the hosted
+cloud. Your data is always yours to export and self-host.
-We support Next.js, React, and JavaScript frontends, along with any backend that can use our [REST API](https://docs.stack-auth.com/api/overview). Check out our [setup guide](https://docs.stack-auth.com/docs/next/getting-started/setup) to get started.
+[Website](https://hexclave.com) ยท [Docs](https://docs.hexclave.com) ยท [Dashboard](https://app.hexclave.com) ยท [Discord](https://discord.hexclave.com)
+
+
+
+
-
-
-## Table of contents
+---
-
-
+
+ 
+
-- [How is this different from X?](#how-is-this-different-from-x)
-- [โจ Features](#-features)
-- [๐ฆ Installation & Setup](#-installation--setup)
-- [๐ฑ Some community projects built with Stack Auth](#-some-community-projects-built-with-stack-auth)
- - [Templates](#templates)
- - [Examples](#examples)
-- [๐ Development & Contribution](#-development--contribution)
- - [Requirements](#requirements)
- - [Setup](#setup)
- - [Useful commands](#useful-commands)
-- [โค Contributors](#-contributors)
+## Get started
-
+Setting up Hexclave is one prompt. Paste this into your coding agent of choice:
-## How is this different from X?
+```text
+Read skill.hexclave.com and help me setup hexclave in this project
+```
-Ask yourself about `X`:
+## What's included
-- Is `X` open-source?
-- Is `X` developer-friendly, well-documented, and lets you get started in minutes?
-- Besides authentication, does `X` also do authorization and user management (see feature list below)?
+Hexclave ships as a catalog of apps you switch on as your product needs them.
+Each one is built on the same user model, and new apps land regularly.
-If you answered "no" to any of these questions, then that's how Stack Auth is different from `X`.
+
+
-## โจ Features
+###  Authentication
-To get notified first when we add new features, please subscribe to [our newsletter](https://stack-auth.beehiiv.com/subscribe).
+Authentication that just works with passkeys, OAuth, and CLI auth. Drop in one component and ship the whole flow; auth methods toggle from the dashboard with no code changes needed.
-| | |
-|-|:-:|
-| ` Authentication components that support OAuth, password credentials, and magic links, with shared development keys to make setup faster. All components support dark/light modes. | |
+
+
+ |
+
|
-| 
|
-| 
|
-| 
|
-| 
|
-| 
|
-| 
|
-| 
|
-| 
|
-| 
|
-| 
|
+
-## ๐ฆ Installation & Setup
+###  Teams
-To install Stack Auth in your Next.js project (for React, JavaScript, or other frameworks, see our [complete documentation](https://docs.stack-auth.com)):
+Build for teams, not just users, with workspaces, email invites, and roles that actually gate the work. The workspace switcher remembers selection, invites auto sign up new users, and permissions hold up under audit.
-1. Run Stack Auth's installation wizard with the following command:
- ```bash
- npx @stackframe/stack-cli@latest init
- ```
+ |
+
+
+ |
+
-Check out the [documentation](https://docs.stack-auth.com/getting-started/setup) for a more detailed guide.
+###  RBAC
-## ๐ฑ Some community projects built with Stack Auth
+Permissions, sorted: roles that nest and one permission check that works the same on server or client. Define them in the dashboard, check them anywhere in your code.
-Have your own? Happy to feature it if you create a PR or message us on [Discord](https://discord.stack-auth.com).
+ |
+
+
+ |
+
-### Examples
-- [Stack Auth Example by career-tokens](https://github.com/career-tokens/StackYCAuth)
-- [Stack Auth Demo by the Stack Auth team](https://github.com/hexclave/stack-auth/tree/dev/examples/demo)
-- [Stack Auth E-Commerce Example by the Stack Auth team](https://github.com/hexclave/stack-auth/tree/dev/examples/e-commerce)
+###  API Keys
-## ๐ Development & Contribution
+API keys without the footguns: leaked keys get auto-revoked, work for users and teams, and show the full secret only once. We never keep the plaintext after creation.
-This is for you if you want to contribute to the Stack Auth project or run the Stack Auth dashboard locally.
+ |
+
+
+ |
+
-### Requirements
+###  Payments
-- Node v20
-- pnpm v9
-- Docker
+Payments without the plumbing for subscriptions, one-time charges, and usage metering with credits. Bill a person or a whole team with one model, no separate codepath.
-### Setup
+ |
+
+
+ |
+
-In a new terminal:
+###  Emails
-```sh
-pnpm install
+Email that delivers and tells you so, handling transactional and marketing sends from one API. Edit templates with an AI editor, theme once, and track every open and click.
-# Build the packages and generate code. We only need to do this once, as `pnpm dev` will do this from now on
-pnpm build:packages
-pnpm codegen
+ |
+
+
+ |
+
-# Start the dev server
-pnpm dev
+###  Analytics
-# In a different terminal, run tests in watch mode
-pnpm test # useful: --no-watch (disables watch mode) and --bail 1 (stops after the first failure)
-```
+Know your users with no data stack required, with live active user counts and session replays out of the box. Ask in plain English to build dashboards or write SQL to save queries, all with one flag enabled.
-You can now open the dev launchpad at [http://localhost:8100](http://localhost:8100). From there, you can navigate to the dashboard at [http://localhost:8101](http://localhost:8101), API on port 8102, demo on port 8103, docs on port 8104, Inbucket (e-mails) on port 8105, and Prisma Studio on port 8106. See the dev launchpad for a list of all running services.
+ |
+
+
+ |
+
-Pre-populated .env files for the setup below are available and used by default in `.env.development` in each of the packages. However, if you're creating a production build (eg. with `pnpm run build`), you must supply the environment variables manually (see below).
+###  Webhooks
-### Useful commands
+React to every user event in real time with signed, tamper-proof webhooks. Retries and backoff are handled for you; verify in five lines and manage endpoints from the dashboard.
-```sh
-# NOTE:
-# Please see the dev launchpad (default: http://localhost:8100) for a list of all running services.
+ |
+
+
+ |
+
-# Types & linting commands
-pnpm typecheck: Runs the TypeScript type checker. May require a build or dev server to run first.
-pnpm lint: Runs the ESLint linter. Optionally, pass `--fix` to fix some of the linting errors. May require a build or dev server to run first.
+###  Data Vault
-# Build commands
-pnpm build: Builds all projects, including apps, packages, examples, and docs. Also runs code-generation tasks. Before you can run this, you will have to copy all `.env.development` files in the folders to `.env.production.local` or set the environment variables manually.
-pnpm build:packages: Builds all the npm packages.
-pnpm codegen: Runs all the code-generation tasks, eg. Prisma client and OpenAPI docs generation.
+A safe for the secrets your users hand you, locked with your secret so we never see the plaintext. Store and retrieve tokens in two lines each, server-only by design.
-# Development commands
-pnpm dev: Runs the development servers of the main projects, excluding most examples. On the first run, requires the packages to be built and codegen to be run. After that, it will watch for file changes (including those in code-generation files). If you have to restart the development server for anything, that is a bug that you can report.
-pnpm dev:full: Runs the development servers for all projects, including examples.
-pnpm dev:basic: Runs the development servers only for the necessary services (backend and dashboard). Not recommended for most users, upgrade your machine instead.
+ |
+
+
+ |
+
-# Database commands
-pnpm db:migration-gen: Currently not used. Please generate Prisma migrations manually (or with AI).
-pnpm db:reset: Resets the database to the initial state. Run automatically by `pnpm start-deps`.
-pnpm db:init: Initializes the database with the seed script & migrations. Run automatically by `pnpm db:reset`.
-pnpm db:seed: Re-seeds the database with the seed script. Run automatically by `pnpm db:init`.
-pnpm db:migrate: Runs the migrations. Run automatically by `pnpm db:init`.
+###  Launch Checklist
-# Testing commands
-pnpm test |
+
+
+ |
+