mirror of
https://github.com/stack-auth/stack.git
synced 2026-06-13 21:01:21 +08:00
3d06e5e381
## Summary Rebuilds the project README from scratch for the Stack Auth → Hexclave rebrand. The previous README was out of date. The README rewrite also surfaced a few stale Stack-Auth references in adjacent docs, which are fixed in the same PR. ### README New structure: - **Top section**: name, "The user infrastructure platform" tagline, intro paragraph, links, and badges - **Get started**: a single AI-agent setup prompt (`Read skill.hexclave.com and help me setup hexclave in this project`) - **What's included**: a catalog of the non-alpha apps (Authentication, Teams, RBAC, API Keys, Payments, Emails, Analytics, Webhooks, Data Vault, Launch Checklist), each with a logo, blurb, and screenshot - **Contributing**: pointer to `CONTRIBUTING.md`, Discord, and the security contact - **Contributors**: restored at the bottom, now pointing at the correct `hexclave/stack-auth` repo on contrib.rocks Note: an explicit **SDKs** section was intentionally dropped for now — the `@hexclave/next`, `@hexclave/react`, `@hexclave/js` packages aren't yet published under that scope, and surfacing install instructions for unpublished packages would just confuse landing users. The badges in the header still call out the supported SDKs, and the setup prompt routes users to docs. We'll add a dedicated SDKs section once the packages exist. ### CONTRIBUTING.md & SECURITY.md Both still referenced Stack Auth after the README rewrite. Updated: - `CONTRIBUTING.md`: "Stack Auth" → "Hexclave", `discord.stack-auth.com` → `discord.hexclave.com`, `docs.stack-auth.com` → `docs.hexclave.com`, `security@stack-auth.com` → `security@hexclave.com` - `.github/SECURITY.md`: "Stack Auth" → "Hexclave", `team@stack-auth.com` → `team@hexclave.com`, `security@stack-auth.com` → `security@hexclave.com` This keeps the disclosure flow consistent across the three docs. ### Markdown lint / a11y polish - Added a `text` language tag to the bare fenced block under "Get started" (markdownlint MD040) - Added `alt=""` to the 10 inline heading logos (markdownlint MD045) — empty alt is correct here because the heading text immediately to the right already names the section, so the logo is decorative ## Open items A few rebrand details still need confirmation; this PR assumes them and uses them in copy: - Domains assumed: `hexclave.com`, `docs.hexclave.com`, `app.hexclave.com`, `discord.hexclave.com`, `security@hexclave.com`, `team@hexclave.com`. Only `skill.hexclave.com` is confirmed. - The `skill.hexclave.com` setup-prompt page needs to exist for the Get started flow to work. - License and Self-hosting sections were intentionally omitted; the header badges were kept. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Rebranded the project from "Stack Auth" to "Hexclave" with a new streamlined README, hero section, and updated feature catalog * Updated contribution guide with Hexclave-specific links, added Discord coordination before starting work, and adjusted setup instructions * Updated security policy and contact emails for vulnerability reporting and consulting * Refined table-of-contents workflow to target the contributing guide only <!-- review_stack_entry_start --> [](https://app.coderabbit.ai/change-stack/hexclave/stack-auth/pull/1474?utm_source=github_walkthrough&utm_medium=github&utm_campaign=change_stack) <!-- review_stack_entry_end --> <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: BilalG1 <BilalG1@users.noreply.github.com>
182 lines
6.4 KiB
Markdown
182 lines
6.4 KiB
Markdown
<div align="center">
|
|
|
|
<img src=".github/assets/hexclave-header.svg" alt="Hexclave" width="320"/>
|
|
|
|
<br/>
|
|
|
|
**The user infrastructure platform.**
|
|
|
|
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.
|
|
|
|
[Website](https://hexclave.com) · [Docs](https://docs.hexclave.com) · [Dashboard](https://app.hexclave.com) · [Discord](https://discord.hexclave.com)
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
---
|
|
|
|
<div align="center">
|
|
<img src=".github/assets/comparison.png" alt="Where Hexclave fits in the infrastructure stack" width="900"/>
|
|
</div>
|
|
|
|
## Get started
|
|
|
|
Setting up Hexclave is one prompt. Paste this into your coding agent of choice:
|
|
|
|
```text
|
|
Read skill.hexclave.com and help me setup hexclave in this project
|
|
```
|
|
|
|
## What's included
|
|
|
|
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.
|
|
|
|
<table><tr>
|
|
<td width="50%" valign="middle">
|
|
|
|
### <img src=".github/assets/logos/authentication.png" alt="" width="40" align="top"/> Authentication
|
|
|
|
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.
|
|
|
|
</td>
|
|
<td width="50%" valign="middle" align="center">
|
|
<img src=".github/assets/app-shots/authentication.png" width="520" alt="Authentication"/>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<table><tr>
|
|
<td width="50%" valign="middle">
|
|
|
|
### <img src=".github/assets/logos/teams.png" alt="" width="40" align="top"/> Teams
|
|
|
|
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.
|
|
|
|
</td>
|
|
<td width="50%" valign="middle" align="center">
|
|
<img src=".github/assets/app-shots/teams.png" width="520" alt="Teams"/>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<table><tr>
|
|
<td width="50%" valign="middle">
|
|
|
|
### <img src=".github/assets/logos/rbac.png" alt="" width="40" align="top"/> RBAC
|
|
|
|
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.
|
|
|
|
</td>
|
|
<td width="50%" valign="middle" align="center">
|
|
<img src=".github/assets/app-shots/rbac.png" width="520" alt="RBAC"/>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<table><tr>
|
|
<td width="50%" valign="middle">
|
|
|
|
### <img src=".github/assets/logos/api-keys.png" alt="" width="40" align="top"/> API Keys
|
|
|
|
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.
|
|
|
|
</td>
|
|
<td width="50%" valign="middle" align="center">
|
|
<img src=".github/assets/app-shots/api-keys.png" width="520" alt="API Keys"/>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<table><tr>
|
|
<td width="50%" valign="middle">
|
|
|
|
### <img src=".github/assets/logos/payments.png" alt="" width="40" align="top"/> Payments
|
|
|
|
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.
|
|
|
|
</td>
|
|
<td width="50%" valign="middle" align="center">
|
|
<img src=".github/assets/app-shots/payments.png" width="520" alt="Payments"/>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<table><tr>
|
|
<td width="50%" valign="middle">
|
|
|
|
### <img src=".github/assets/logos/emails.png" alt="" width="40" align="top"/> Emails
|
|
|
|
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.
|
|
|
|
</td>
|
|
<td width="50%" valign="middle" align="center">
|
|
<img src=".github/assets/app-shots/emails.png" width="520" alt="Emails"/>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<table><tr>
|
|
<td width="50%" valign="middle">
|
|
|
|
### <img src=".github/assets/logos/analytics.png" alt="" width="40" align="top"/> Analytics
|
|
|
|
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.
|
|
|
|
</td>
|
|
<td width="50%" valign="middle" align="center">
|
|
<img src=".github/assets/app-shots/analytics.png" width="520" alt="Analytics"/>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<table><tr>
|
|
<td width="50%" valign="middle">
|
|
|
|
### <img src=".github/assets/logos/webhooks.png" alt="" width="40" align="top"/> Webhooks
|
|
|
|
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.
|
|
|
|
</td>
|
|
<td width="50%" valign="middle" align="center">
|
|
<img src=".github/assets/app-shots/webhooks.png" width="520" alt="Webhooks"/>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<table><tr>
|
|
<td width="50%" valign="middle">
|
|
|
|
### <img src=".github/assets/logos/data-vault.png" alt="" width="40" align="top"/> Data Vault
|
|
|
|
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.
|
|
|
|
</td>
|
|
<td width="50%" valign="middle" align="center">
|
|
<img src=".github/assets/app-shots/data-vault.png" width="520" alt="Data Vault"/>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<table><tr>
|
|
<td width="50%" valign="middle">
|
|
|
|
### <img src=".github/assets/logos/launch-checklist.png" alt="" width="40" align="top"/> Launch Checklist
|
|
|
|
Run through the must-do checks before flipping to production: domain setup, callbacks locked, secrets rotated. The progress tracker keeps your team aligned so nothing critical slips through on launch day.
|
|
|
|
</td>
|
|
<td width="50%" valign="middle" align="center">
|
|
<img src=".github/assets/app-shots/launch-checklist.png" width="520" alt="Launch Checklist"/>
|
|
</td>
|
|
</tr></table>
|
|
|
|
## Contributing
|
|
|
|
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
|
|
|
|
<a href="https://github.com/hexclave/stack-auth/graphs/contributors">
|
|
<img src="https://contrib.rocks/image?repo=hexclave/stack-auth&columns=9" alt="Contributors" width="100%" />
|
|
</a>
|