From 1f386b6e25644e54d7e1332efa8164573067ca82 Mon Sep 17 00:00:00 2001 From: Lawrence Chen Date: Tue, 24 Mar 2026 20:59:48 -0700 Subject: [PATCH 1/2] Add README translations for 9 languages MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add translated README files with language selector at the top of each: 繁體中文, 简体中文, 日本語, 한국어, Deutsch, Español, Français, Italiano, Português (Brasil). Translations were generated by Claude. Each translated file includes a disclaimer noting this and welcoming PRs to improve them. --- README.de.md | 183 ++++++++++++++++++++++++++++++++++++++++++++++++ README.es.md | 183 ++++++++++++++++++++++++++++++++++++++++++++++++ README.fr.md | 183 ++++++++++++++++++++++++++++++++++++++++++++++++ README.it.md | 183 ++++++++++++++++++++++++++++++++++++++++++++++++ README.ja.md | 183 ++++++++++++++++++++++++++++++++++++++++++++++++ README.ko.md | 183 ++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 4 ++ README.pt-BR.md | 183 ++++++++++++++++++++++++++++++++++++++++++++++++ README.zh-CN.md | 183 ++++++++++++++++++++++++++++++++++++++++++++++++ README.zh-TW.md | 183 ++++++++++++++++++++++++++++++++++++++++++++++++ 10 files changed, 1651 insertions(+) create mode 100644 README.de.md create mode 100644 README.es.md create mode 100644 README.fr.md create mode 100644 README.it.md create mode 100644 README.ja.md create mode 100644 README.ko.md create mode 100644 README.pt-BR.md create mode 100644 README.zh-CN.md create mode 100644 README.zh-TW.md diff --git a/README.de.md b/README.de.md new file mode 100644 index 0000000000..564f4554c3 --- /dev/null +++ b/README.de.md @@ -0,0 +1,183 @@ +> Diese Übersetzung wurde von Claude generiert. Verbesserungsvorschläge sind als PRs willkommen. + +[![Stack Logo](/.github/assets/logo.png)](https://stack-auth.com) + +

+ 📘 Dokumentation + | ☁️ Gehostete Version + | ✨ Demo + | 🎮 Discord +

+ +

+ English | 繁體中文 | 简体中文 | 日本語 | 한국어 | Deutsch | Español | Français | Italiano | Português (Brasil) +

+ +# Stack Auth: Die Open-Source-Authentifizierungsplattform + +Stack Auth ist eine verwaltete Lösung zur Benutzerauthentifizierung. Sie ist entwicklerfreundlich und vollständig Open Source (lizenziert unter MIT und AGPL). + +Stack Auth bringt Sie in nur fünf Minuten zum Laufen, danach können Sie alle Funktionen nutzen, während Ihr Projekt wächst. Unser verwalteter Dienst ist vollständig optional und Sie können Ihre Benutzerdaten jederzeit kostenlos exportieren und selbst hosten. + +Wir unterstützen Next.js, React und JavaScript-Frontends sowie jedes Backend, das unsere [REST API](https://docs.stack-auth.com/api/overview) nutzen kann. Schauen Sie sich unseren [Einrichtungsleitfaden](https://docs.stack-auth.com/docs/next/getting-started/setup) an, um loszulegen. + +
+Stack Auth Setup +
+ +## Wie unterscheidet sich das von X? + +Stellen Sie sich folgende Fragen über `X`: + +- Ist `X` Open Source? +- Ist `X` entwicklerfreundlich, gut dokumentiert und ermöglicht es Ihnen, in Minuten loszulegen? +- Bietet `X` neben Authentifizierung auch Autorisierung und Benutzerverwaltung (siehe Funktionsliste unten)? + +Wenn Sie eine dieser Fragen mit "Nein" beantwortet haben, dann ist das der Unterschied zwischen Stack Auth und `X`. + +## ✨ Funktionen + +Um als Erster über neue Funktionen informiert zu werden, abonnieren Sie bitte [unseren Newsletter](https://stack-auth.beehiiv.com/subscribe). + +| | | +|-|:-:| +|

`` und ``

Authentifizierungskomponenten, die OAuth, Passwort-Anmeldedaten und Magic Links unterstützen, mit gemeinsamen Entwicklungsschlüsseln für eine schnellere Einrichtung. Alle Komponenten unterstützen Dunkel-/Hellmodus. | Sign-in component | +|

Idiomatische Next.js-APIs

Wir bauen auf Server Components, React Hooks und Route Handlers auf. | ![Dark/light mode](.github/assets/components.png) | +|

Benutzer-Dashboard

Dashboard zum Filtern, Analysieren und Bearbeiten von Benutzern. Ersetzt das erste interne Tool, das Sie sonst bauen müssten. | ![User dashboard](.github/assets/dashboard.png) | +|

Kontoeinstellungen

Ermöglicht Benutzern, ihr Profil zu aktualisieren, ihre E-Mail zu verifizieren oder ihr Passwort zu ändern. Keine Einrichtung erforderlich. | Account settings component | +|

Mandantenfähigkeit & Teams

Verwalten Sie B2B-Kunden mit einer Organisationsstruktur, die sinnvoll ist und auf Millionen skaliert. | Selected team switcher component | +|

Rollenbasierte Zugriffskontrolle

Definieren Sie einen beliebigen Berechtigungsgraphen und weisen Sie ihn Benutzern zu. Organisationen können organisationsspezifische Rollen erstellen. | RBAC | +|

OAuth-Verbindungen

Über die Anmeldung hinaus kann Stack Auth auch Zugriffstoken für Drittanbieter-APIs wie Outlook und Google Calendar verwalten. Es übernimmt die Token-Aktualisierung und Bereichssteuerung und macht Zugriffstoken über einen einzigen Funktionsaufruf verfügbar. | OAuth tokens | +|

Passkeys

Unterstützung für passwortlose Authentifizierung mit Passkeys, die es Benutzern ermöglicht, sich sicher mit Biometrie oder Sicherheitsschlüsseln auf allen ihren Geräten anzumelden. | OAuth tokens | +|

Identitätswechsel

Nehmen Sie die Identität von Benutzern für Debugging und Support an, indem Sie sich in deren Konto einloggen, als wären Sie sie. | Webhooks | +|

Webhooks

Erhalten Sie Benachrichtigungen, wenn Benutzer Ihr Produkt nutzen, basierend auf Svix. | Webhooks | +|

Automatische E-Mails

Senden Sie anpassbare E-Mails bei Ereignissen wie Registrierung, Passwortzurücksetzung und E-Mail-Verifizierung, bearbeitbar mit einem WYSIWYG-Editor. | Email templates | +|

Benutzersitzungs- & JWT-Verwaltung

Stack Auth verwaltet Refresh- und Access-Token, JWTs und Cookies, was zu bester Leistung ohne Implementierungsaufwand führt. | User button | +|

M2M-Authentifizierung

Verwenden Sie kurzlebige Zugriffstoken, um Ihre Maschinen bei anderen Maschinen zu authentifizieren. | M2M authentication | + + +## 📦 Installation & Einrichtung + +Um Stack Auth in Ihrem Next.js-Projekt zu installieren (für React, JavaScript oder andere Frameworks siehe unsere [vollständige Dokumentation](https://docs.stack-auth.com)): + +1. Führen Sie den Installationsassistenten von Stack Auth mit folgendem Befehl aus: + ```bash + npx @stackframe/stack-cli@latest init + ``` + +2. Erstellen Sie dann ein Konto auf dem [Stack Auth Dashboard](https://app.stack-auth.com/projects), erstellen Sie ein neues Projekt mit einem API-Schlüssel und kopieren Sie die Umgebungsvariablen in die .env.local-Datei Ihres Next.js-Projekts: + ``` + NEXT_PUBLIC_STACK_PROJECT_ID= + NEXT_PUBLIC_STACK_PUBLISHABLE_CLIENT_KEY= + STACK_SECRET_SERVER_KEY= + ``` +3. Das war's! Sie können Ihre App mit `npm run dev` starten und [http://localhost:3000/handler/signup](http://localhost:3000/handler/signup) aufrufen, um die Registrierungsseite zu sehen. Sie können auch die Kontoeinstellungsseite unter [http://localhost:3000/handler/account-settings](http://localhost:3000/handler/account-settings) besuchen. + +Schauen Sie sich die [Dokumentation](https://docs.stack-auth.com/getting-started/setup) für eine ausführlichere Anleitung an. + +## 🌱 Einige Community-Projekte mit Stack Auth + +Haben Sie ein eigenes? Wir stellen es gerne vor, wenn Sie einen PR erstellen oder uns auf [Discord](https://discord.stack-auth.com) schreiben. + +### Templates +- [Stack Auth Template by Stack Auth Team](https://github.com/stack-auth/stack-auth-template) +- [Next SaaSkit by wolfgunblood](https://github.com/wolfgunblood/nextjs-saaskit) +- [SaaS Boilerplate by Robin Faraj](https://github.com/robinfaraj/saas-boilerplate) + +### Examples +- [Stack Auth Example by career-tokens](https://github.com/career-tokens/StackYCAuth) +- [Stack Auth Demo by the Stack Auth team](https://github.com/stack-auth/stack-auth/tree/dev/examples/demo) +- [Stack Auth E-Commerce Example by the Stack Auth team](https://github.com/stack-auth/stack-auth/tree/dev/examples/e-commerce) + +## 🏗 Entwicklung & Mitwirkung + +Dieser Abschnitt ist für Sie, wenn Sie zum Stack Auth-Projekt beitragen oder das Stack Auth-Dashboard lokal ausführen möchten. + +**Wichtig**: Bitte lesen Sie die [Mitwirkungsrichtlinien](CONTRIBUTING.md) sorgfältig und treten Sie [unserem Discord](https://discord.stack-auth.com) bei, wenn Sie helfen möchten. + +### Voraussetzungen + +- Node v20 +- pnpm v9 +- Docker + +### Einrichtung + +Hinweis: 24 GB+ RAM werden für eine reibungslose Entwicklungserfahrung empfohlen. + +In einem neuen Terminal: + +```sh +pnpm install + +# Pakete bauen und Code generieren. Dies müssen wir nur einmal tun, da `pnpm dev` dies ab jetzt übernimmt +pnpm build:packages +pnpm codegen + +# Abhängigkeiten (DB, Inbucket, etc.) als Docker-Container starten und die DB mit dem Prisma-Schema initialisieren +# Stellen Sie sicher, dass Docker (oder OrbStack) installiert ist und läuft +pnpm restart-deps + +# Entwicklungsserver starten +pnpm dev + +# In einem anderen Terminal Tests im Watch-Modus ausführen +pnpm test # nützlich: --no-watch (deaktiviert Watch-Modus) und --bail 1 (stoppt nach dem ersten Fehler) +``` + +Sie können jetzt das Dev-Launchpad unter [http://localhost:8100](http://localhost:8100) öffnen. Von dort können Sie zum Dashboard unter [http://localhost:8101](http://localhost:8101) navigieren, zur API auf Port 8102, zur Demo auf Port 8103, zur Dokumentation auf Port 8104, zu Inbucket (E-Mails) auf Port 8105 und zu Prisma Studio auf Port 8106. Siehe das Dev-Launchpad für eine Liste aller laufenden Dienste. + +Ihre IDE zeigt möglicherweise einen Fehler bei allen `@stackframe/XYZ`-Imports an. Um dies zu beheben, starten Sie einfach den TypeScript Language Server neu; z.B. können Sie in VSCode die Befehlspalette (Strg+Umschalt+P) öffnen und `Developer: Reload Window` oder `TypeScript: Restart TS server` ausführen. + +Vorab ausgefüllte .env-Dateien für die untenstehende Einrichtung sind verfügbar und werden standardmäßig in `.env.development` in jedem der Pakete verwendet. Wenn Sie jedoch einen Produktions-Build erstellen (z.B. mit `pnpm run build`), müssen Sie die Umgebungsvariablen manuell bereitstellen (siehe unten). + +### Nützliche Befehle + +```sh +# HINWEIS: +# Bitte sehen Sie sich das Dev-Launchpad (Standard: http://localhost:8100) für eine Liste aller laufenden Dienste an. + +# Installationsbefehle +pnpm install: Installiert Abhängigkeiten + +# Typ- & Linting-Befehle +pnpm typecheck: Führt den TypeScript-Typprüfer aus. Erfordert möglicherweise einen Build oder laufenden Dev-Server. +pnpm lint: Führt den ESLint-Linter aus. Optional `--fix` übergeben, um einige Linting-Fehler zu beheben. Erfordert möglicherweise einen Build oder laufenden Dev-Server. + +# Build-Befehle +pnpm build: Baut alle Projekte, einschließlich Apps, Pakete, Beispiele und Dokumentation. Führt auch Code-Generierungsaufgaben aus. Bevor Sie dies ausführen können, müssen Sie alle `.env.development`-Dateien in den Ordnern nach `.env.production.local` kopieren oder die Umgebungsvariablen manuell setzen. +pnpm build:packages: Baut alle npm-Pakete. +pnpm codegen: Führt alle Code-Generierungsaufgaben aus, z.B. Prisma-Client- und OpenAPI-Dokumentationsgenerierung. + +# Entwicklungsbefehle +pnpm dev: Führt die Entwicklungsserver der Hauptprojekte aus, ohne die meisten Beispiele. Beim ersten Ausführen müssen die Pakete gebaut und Codegen ausgeführt sein. Danach überwacht es Dateiänderungen (einschließlich Code-Generierungsdateien). Wenn Sie den Entwicklungsserver aus irgendeinem Grund neu starten müssen, ist das ein Bug, den Sie melden können. +pnpm dev:full: Führt die Entwicklungsserver für alle Projekte aus, einschließlich Beispiele. +pnpm dev:basic: Führt die Entwicklungsserver nur für die notwendigen Dienste (Backend und Dashboard) aus. Für die meisten Benutzer nicht empfohlen, upgraden Sie stattdessen Ihre Hardware. + +# Umgebungsbefehle +pnpm start-deps: Startet die Docker-Abhängigkeiten (DB, Inbucket, etc.) als Docker-Container und initialisiert sie mit dem Seed-Skript & Migrationen. Hinweis: Die gestarteten Abhängigkeiten sind im Dev-Launchpad (standardmäßig Port 8100) sichtbar. +pnpm stop-deps: Stoppt die Docker-Abhängigkeiten (DB, Inbucket, etc.) und löscht deren Daten. +pnpm restart-deps: Stoppt und startet die Abhängigkeiten. + +# Datenbankbefehle +pnpm db:migration-gen: Derzeit nicht verwendet. Bitte generieren Sie Prisma-Migrationen manuell (oder mit KI). +pnpm db:reset: Setzt die Datenbank auf den Ausgangszustand zurück. Wird automatisch von `pnpm start-deps` ausgeführt. +pnpm db:init: Initialisiert die Datenbank mit dem Seed-Skript & Migrationen. Wird automatisch von `pnpm db:reset` ausgeführt. +pnpm db:seed: Befüllt die Datenbank erneut mit dem Seed-Skript. Wird automatisch von `pnpm db:init` ausgeführt. +pnpm db:migrate: Führt die Migrationen aus. Wird automatisch von `pnpm db:init` ausgeführt. + +# Testbefehle +pnpm test : Führt die Tests aus. `--bail 1` übergeben, damit der Test nach dem ersten Fehler stoppt. `--no-watch` übergeben, um die Tests einmal statt im Watch-Modus auszuführen. + +# Verschiedene Befehle +pnpm explain-query: Fügen Sie eine SQL-Abfrage ein, um eine Erklärung des Abfrageplans zu erhalten, die Ihnen beim Debuggen von Leistungsproblemen hilft. +pnpm verify-data-integrity: Überprüft die Integrität der Daten in der Datenbank durch eine Reihe von Integritätsprüfungen. Dies sollte zu keinem Zeitpunkt fehlschlagen (es sei denn, Sie haben manuell an der DB herumgespielt). +``` + +Hinweis: Bei der Arbeit mit KI sollten Sie einen Terminal-Tab mit dem Dev-Server offen halten, damit die KI Abfragen dagegen ausführen kann. + +## ❤ Mitwirkende + + + + diff --git a/README.es.md b/README.es.md new file mode 100644 index 0000000000..845e707b08 --- /dev/null +++ b/README.es.md @@ -0,0 +1,183 @@ +> Esta traducción fue generada por Claude. Si tienes sugerencias de mejora, los PRs son bienvenidos. + +[![Stack Logo](/.github/assets/logo.png)](https://stack-auth.com) + +

+ 📘 Documentación + | ☁️ Versión alojada + | ✨ Demo + | 🎮 Discord +

+ +

+ English | 繁體中文 | 简体中文 | 日本語 | 한국어 | Deutsch | Español | Français | Italiano | Português (Brasil) +

+ +# Stack Auth: La plataforma de autenticación de código abierto + +Stack Auth es una solución gestionada de autenticación de usuarios. Es amigable para desarrolladores y completamente de código abierto (licenciada bajo MIT y AGPL). + +Stack Auth te permite comenzar en solo cinco minutos, después de lo cual estarás listo para usar todas sus funcionalidades a medida que tu proyecto crezca. Nuestro servicio gestionado es completamente opcional y puedes exportar tus datos de usuario y alojar tú mismo, gratis, en cualquier momento. + +Soportamos frontends de Next.js, React y JavaScript, junto con cualquier backend que pueda usar nuestra [API REST](https://docs.stack-auth.com/api/overview). Consulta nuestra [guía de configuración](https://docs.stack-auth.com/docs/next/getting-started/setup) para comenzar. + +
+Stack Auth Setup +
+ +## ¿En qué se diferencia de X? + +Pregúntate sobre `X`: + +- ¿Es `X` de código abierto? +- ¿Es `X` amigable para desarrolladores, está bien documentado y te permite comenzar en minutos? +- Además de autenticación, ¿`X` también ofrece autorización y gestión de usuarios (ver lista de funcionalidades abajo)? + +Si respondiste "no" a alguna de estas preguntas, entonces así es como Stack Auth se diferencia de `X`. + +## ✨ Funcionalidades + +Para ser el primero en enterarte cuando agreguemos nuevas funcionalidades, suscríbete a [nuestro boletín](https://stack-auth.beehiiv.com/subscribe). + +| | | +|-|:-:| +|

`` y ``

Componentes de autenticación que soportan OAuth, credenciales de contraseña y magic links, con claves de desarrollo compartidas para acelerar la configuración. Todos los componentes soportan modo oscuro/claro. | Sign-in component | +|

APIs idiomáticas de Next.js

Construimos sobre server components, React hooks y route handlers. | ![Dark/light mode](.github/assets/components.png) | +|

Panel de usuarios

Panel para filtrar, analizar y editar usuarios. Reemplaza la primera herramienta interna que tendrías que construir. | ![User dashboard](.github/assets/dashboard.png) | +|

Configuración de cuenta

Permite a los usuarios actualizar su perfil, verificar su correo electrónico o cambiar su contraseña. Sin configuración necesaria. | Account settings component | +|

Multi-tenencia y equipos

Gestiona clientes B2B con una estructura organizacional que tiene sentido y escala a millones. | Selected team switcher component | +|

Control de acceso basado en roles

Define un grafo de permisos arbitrario y asígnalo a usuarios. Las organizaciones pueden crear roles específicos de la organización. | RBAC | +|

Conexiones OAuth

Más allá del inicio de sesión, Stack Auth también puede gestionar tokens de acceso para APIs de terceros, como Outlook y Google Calendar. Se encarga de renovar tokens y controlar el alcance, haciendo que los tokens de acceso sean accesibles mediante una sola llamada de función. | OAuth tokens | +|

Passkeys

Soporte para autenticación sin contraseña usando passkeys, permitiendo a los usuarios iniciar sesión de forma segura con biometría o llaves de seguridad en todos sus dispositivos. | OAuth tokens | +|

Suplantación de identidad

Suplanta la identidad de usuarios para depuración y soporte, iniciando sesión en su cuenta como si fueras ellos. | Webhooks | +|

Webhooks

Recibe notificaciones cuando los usuarios usen tu producto, construido sobre Svix. | Webhooks | +|

Correos automáticos

Envía correos personalizables ante eventos como registro, restablecimiento de contraseña y verificación de correo, editables con un editor WYSIWYG. | Email templates | +|

Gestión de sesiones de usuario y JWT

Stack Auth gestiona tokens de actualización y acceso, JWTs y cookies, resultando en el mejor rendimiento sin costo de implementación. | User button | +|

Autenticación M2M

Usa tokens de acceso de corta duración para autenticar tus máquinas con otras máquinas. | M2M authentication | + + +## 📦 Instalación y configuración + +Para instalar Stack Auth en tu proyecto Next.js (para React, JavaScript u otros frameworks, consulta nuestra [documentación completa](https://docs.stack-auth.com)): + +1. Ejecuta el asistente de instalación de Stack Auth con el siguiente comando: + ```bash + npx @stackframe/stack-cli@latest init + ``` + +2. Luego, crea una cuenta en el [panel de Stack Auth](https://app.stack-auth.com/projects), crea un nuevo proyecto con una clave API y copia las variables de entorno en el archivo .env.local de tu proyecto Next.js: + ``` + NEXT_PUBLIC_STACK_PROJECT_ID= + NEXT_PUBLIC_STACK_PUBLISHABLE_CLIENT_KEY= + STACK_SECRET_SERVER_KEY= + ``` +3. ¡Eso es todo! Puedes ejecutar tu app con `npm run dev` e ir a [http://localhost:3000/handler/signup](http://localhost:3000/handler/signup) para ver la página de registro. También puedes visitar la página de configuración de cuenta en [http://localhost:3000/handler/account-settings](http://localhost:3000/handler/account-settings). + +Consulta la [documentación](https://docs.stack-auth.com/getting-started/setup) para una guía más detallada. + +## 🌱 Algunos proyectos de la comunidad construidos con Stack Auth + +¿Tienes el tuyo? Estaremos encantados de destacarlo si creas un PR o nos escribes en [Discord](https://discord.stack-auth.com). + +### Templates +- [Stack Auth Template by Stack Auth Team](https://github.com/stack-auth/stack-auth-template) +- [Next SaaSkit by wolfgunblood](https://github.com/wolfgunblood/nextjs-saaskit) +- [SaaS Boilerplate by Robin Faraj](https://github.com/robinfaraj/saas-boilerplate) + +### Examples +- [Stack Auth Example by career-tokens](https://github.com/career-tokens/StackYCAuth) +- [Stack Auth Demo by the Stack Auth team](https://github.com/stack-auth/stack-auth/tree/dev/examples/demo) +- [Stack Auth E-Commerce Example by the Stack Auth team](https://github.com/stack-auth/stack-auth/tree/dev/examples/e-commerce) + +## 🏗 Desarrollo y contribución + +Esto es para ti si quieres contribuir al proyecto Stack Auth o ejecutar el panel de Stack Auth localmente. + +**Importante**: Por favor lee las [guías de contribución](CONTRIBUTING.md) cuidadosamente y únete a [nuestro Discord](https://discord.stack-auth.com) si deseas ayudar. + +### Requisitos + +- Node v20 +- pnpm v9 +- Docker + +### Configuración + +Nota: Se recomiendan 24 GB+ de RAM para una experiencia de desarrollo fluida. + +En una nueva terminal: + +```sh +pnpm install + +# Compilar los paquetes y generar código. Solo necesitamos hacer esto una vez, ya que `pnpm dev` lo hará de ahora en adelante +pnpm build:packages +pnpm codegen + +# Iniciar las dependencias (BD, Inbucket, etc.) como contenedores Docker, inicializando la BD con el esquema de Prisma +# Asegúrate de tener Docker (u OrbStack) instalado y ejecutándose +pnpm restart-deps + +# Iniciar el servidor de desarrollo +pnpm dev + +# En otra terminal, ejecutar tests en modo watch +pnpm test # útil: --no-watch (desactiva modo watch) y --bail 1 (se detiene tras el primer fallo) +``` + +Ahora puedes abrir el launchpad de desarrollo en [http://localhost:8100](http://localhost:8100). Desde allí, puedes navegar al panel en [http://localhost:8101](http://localhost:8101), la API en el puerto 8102, la demo en el puerto 8103, la documentación en el puerto 8104, Inbucket (correos) en el puerto 8105 y Prisma Studio en el puerto 8106. Consulta el launchpad de desarrollo para ver una lista de todos los servicios en ejecución. + +Tu IDE puede mostrar un error en todos los imports de `@stackframe/XYZ`. Para solucionarlo, simplemente reinicia el servidor de lenguaje TypeScript; por ejemplo, en VSCode puedes abrir la paleta de comandos (Ctrl+Shift+P) y ejecutar `Developer: Reload Window` o `TypeScript: Restart TS server`. + +Archivos .env pre-completados para la configuración siguiente están disponibles y se usan por defecto en `.env.development` en cada uno de los paquetes. Sin embargo, si estás creando una build de producción (ej. con `pnpm run build`), debes proporcionar las variables de entorno manualmente (ver abajo). + +### Comandos útiles + +```sh +# NOTA: +# Por favor consulta el launchpad de desarrollo (por defecto: http://localhost:8100) para ver una lista de todos los servicios en ejecución. + +# Comandos de instalación +pnpm install: Instala dependencias + +# Comandos de tipos y linting +pnpm typecheck: Ejecuta el verificador de tipos de TypeScript. Puede requerir una build o servidor de desarrollo en ejecución primero. +pnpm lint: Ejecuta el linter ESLint. Opcionalmente, pasa `--fix` para corregir algunos errores de linting. Puede requerir una build o servidor de desarrollo en ejecución primero. + +# Comandos de build +pnpm build: Compila todos los proyectos, incluyendo apps, paquetes, ejemplos y documentación. También ejecuta tareas de generación de código. Antes de ejecutar esto, deberás copiar todos los archivos `.env.development` en las carpetas a `.env.production.local` o configurar las variables de entorno manualmente. +pnpm build:packages: Compila todos los paquetes npm. +pnpm codegen: Ejecuta todas las tareas de generación de código, ej. generación del cliente Prisma y documentación OpenAPI. + +# Comandos de desarrollo +pnpm dev: Ejecuta los servidores de desarrollo de los proyectos principales, excluyendo la mayoría de los ejemplos. En la primera ejecución, requiere que los paquetes estén compilados y codegen ejecutado. Después, observará los cambios en archivos (incluyendo los de generación de código). Si tienes que reiniciar el servidor de desarrollo por cualquier motivo, eso es un bug que puedes reportar. +pnpm dev:full: Ejecuta los servidores de desarrollo para todos los proyectos, incluyendo ejemplos. +pnpm dev:basic: Ejecuta los servidores de desarrollo solo para los servicios necesarios (backend y panel). No recomendado para la mayoría de usuarios, mejora tu máquina en su lugar. + +# Comandos de entorno +pnpm start-deps: Inicia las dependencias Docker (BD, Inbucket, etc.) como contenedores Docker, y las inicializa con el script seed y migraciones. Nota: Las dependencias iniciadas serán visibles en el launchpad de desarrollo (puerto 8100 por defecto). +pnpm stop-deps: Detiene las dependencias Docker (BD, Inbucket, etc.) y elimina sus datos. +pnpm restart-deps: Detiene e inicia las dependencias. + +# Comandos de base de datos +pnpm db:migration-gen: Actualmente no se usa. Por favor genera las migraciones de Prisma manualmente (o con IA). +pnpm db:reset: Restablece la base de datos al estado inicial. Se ejecuta automáticamente con `pnpm start-deps`. +pnpm db:init: Inicializa la base de datos con el script seed y migraciones. Se ejecuta automáticamente con `pnpm db:reset`. +pnpm db:seed: Re-inicializa la base de datos con el script seed. Se ejecuta automáticamente con `pnpm db:init`. +pnpm db:migrate: Ejecuta las migraciones. Se ejecuta automáticamente con `pnpm db:init`. + +# Comandos de pruebas +pnpm test : Ejecuta las pruebas. Pasa `--bail 1` para que las pruebas se detengan tras el primer fallo. Pasa `--no-watch` para ejecutar las pruebas una vez en lugar de en modo watch. + +# Comandos varios +pnpm explain-query: Pega una consulta SQL para obtener una explicación del plan de consulta, ayudándote a depurar problemas de rendimiento. +pnpm verify-data-integrity: Verifica la integridad de los datos en la base de datos ejecutando una serie de verificaciones de integridad. Esto nunca debería fallar en ningún momento (a menos que hayas manipulado la BD manualmente). +``` + +Nota: Al trabajar con IA, deberías mantener una pestaña de terminal con el servidor de desarrollo abierto para que la IA pueda ejecutar consultas contra él. + +## ❤ Colaboradores + + + + diff --git a/README.fr.md b/README.fr.md new file mode 100644 index 0000000000..8036092405 --- /dev/null +++ b/README.fr.md @@ -0,0 +1,183 @@ +> Cette traduction a été générée par Claude. Les suggestions d'amélioration via PR sont les bienvenues. + +[![Stack Logo](/.github/assets/logo.png)](https://stack-auth.com) + +

+ 📘 Documentation + | ☁️ Version hébergée + | ✨ Démo + | 🎮 Discord +

+ +

+ English | 繁體中文 | 简体中文 | 日本語 | 한국어 | Deutsch | Español | Français | Italiano | Português (Brasil) +

+ +# Stack Auth : La plateforme d'authentification open source + +Stack Auth est une solution gérée d'authentification des utilisateurs. Elle est conçue pour les développeurs et entièrement open source (sous licence MIT et AGPL). + +Stack Auth vous permet de démarrer en seulement cinq minutes, après quoi vous serez prêt à utiliser toutes ses fonctionnalités au fur et à mesure que votre projet évolue. Notre service géré est entièrement optionnel et vous pouvez exporter vos données utilisateur et héberger vous-même, gratuitement, à tout moment. + +Nous prenons en charge les frontends Next.js, React et JavaScript, ainsi que tout backend pouvant utiliser notre [API REST](https://docs.stack-auth.com/api/overview). Consultez notre [guide de configuration](https://docs.stack-auth.com/docs/next/getting-started/setup) pour commencer. + +
+Stack Auth Setup +
+ +## En quoi est-ce différent de X ? + +Posez-vous ces questions à propos de `X` : + +- `X` est-il open source ? +- `X` est-il conçu pour les développeurs, bien documenté, et permet-il de démarrer en quelques minutes ? +- En plus de l'authentification, `X` propose-t-il aussi l'autorisation et la gestion des utilisateurs (voir la liste des fonctionnalités ci-dessous) ? + +Si vous avez répondu "non" à l'une de ces questions, c'est en cela que Stack Auth diffère de `X`. + +## ✨ Fonctionnalités + +Pour être informé en priorité des nouvelles fonctionnalités, abonnez-vous à [notre newsletter](https://stack-auth.beehiiv.com/subscribe). + +| | | +|-|:-:| +|

`` et ``

Composants d'authentification prenant en charge OAuth, les identifiants par mot de passe et les magic links, avec des clés de développement partagées pour accélérer la configuration. Tous les composants supportent les modes sombre/clair. | Sign-in component | +|

APIs idiomatiques Next.js

Nous nous appuyons sur les server components, les React hooks et les route handlers. | ![Dark/light mode](.github/assets/components.png) | +|

Tableau de bord utilisateurs

Tableau de bord pour filtrer, analyser et modifier les utilisateurs. Remplace le premier outil interne que vous auriez dû construire. | ![User dashboard](.github/assets/dashboard.png) | +|

Paramètres du compte

Permet aux utilisateurs de mettre à jour leur profil, de vérifier leur adresse e-mail ou de changer leur mot de passe. Aucune configuration requise. | Account settings component | +|

Multi-tenancy et équipes

Gérez vos clients B2B avec une structure organisationnelle cohérente qui évolue jusqu'à des millions d'utilisateurs. | Selected team switcher component | +|

Contrôle d'accès basé sur les rôles

Définissez un graphe de permissions arbitraire et attribuez-le aux utilisateurs. Les organisations peuvent créer des rôles spécifiques à leur organisation. | RBAC | +|

Connexions OAuth

Au-delà de la connexion, Stack Auth peut également gérer les tokens d'accès pour les APIs tierces, comme Outlook et Google Calendar. Il gère le renouvellement des tokens et le contrôle des scopes, rendant les tokens d'accès accessibles via un seul appel de fonction. | OAuth tokens | +|

Passkeys

Prise en charge de l'authentification sans mot de passe via les passkeys, permettant aux utilisateurs de se connecter en toute sécurité avec la biométrie ou des clés de sécurité sur tous leurs appareils. | OAuth tokens | +|

Usurpation d'identité

Prenez l'identité des utilisateurs pour le débogage et le support, en vous connectant à leur compte comme si vous étiez eux. | Webhooks | +|

Webhooks

Soyez notifié lorsque les utilisateurs utilisent votre produit, construit sur Svix. | Webhooks | +|

E-mails automatiques

Envoyez des e-mails personnalisables déclenchés par des événements tels que l'inscription, la réinitialisation du mot de passe et la vérification d'e-mail, modifiables avec un éditeur WYSIWYG. | Email templates | +|

Gestion des sessions utilisateur et JWT

Stack Auth gère les tokens de rafraîchissement et d'accès, les JWTs et les cookies, offrant les meilleures performances sans coût d'implémentation. | User button | +|

Authentification M2M

Utilisez des tokens d'accès à courte durée de vie pour authentifier vos machines auprès d'autres machines. | M2M authentication | + + +## 📦 Installation et configuration + +Pour installer Stack Auth dans votre projet Next.js (pour React, JavaScript ou d'autres frameworks, consultez notre [documentation complète](https://docs.stack-auth.com)) : + +1. Lancez l'assistant d'installation de Stack Auth avec la commande suivante : + ```bash + npx @stackframe/stack-cli@latest init + ``` + +2. Ensuite, créez un compte sur le [tableau de bord Stack Auth](https://app.stack-auth.com/projects), créez un nouveau projet avec une clé API et copiez ses variables d'environnement dans le fichier .env.local de votre projet Next.js : + ``` + NEXT_PUBLIC_STACK_PROJECT_ID= + NEXT_PUBLIC_STACK_PUBLISHABLE_CLIENT_KEY= + STACK_SECRET_SERVER_KEY= + ``` +3. C'est tout ! Vous pouvez lancer votre application avec `npm run dev` et accéder à [http://localhost:3000/handler/signup](http://localhost:3000/handler/signup) pour voir la page d'inscription. Vous pouvez également consulter la page de paramètres du compte sur [http://localhost:3000/handler/account-settings](http://localhost:3000/handler/account-settings). + +Consultez la [documentation](https://docs.stack-auth.com/getting-started/setup) pour un guide plus détaillé. + +## 🌱 Quelques projets communautaires construits avec Stack Auth + +Vous avez le vôtre ? Nous serons ravis de le mettre en avant si vous créez une PR ou nous contactez sur [Discord](https://discord.stack-auth.com). + +### Templates +- [Stack Auth Template by Stack Auth Team](https://github.com/stack-auth/stack-auth-template) +- [Next SaaSkit by wolfgunblood](https://github.com/wolfgunblood/nextjs-saaskit) +- [SaaS Boilerplate by Robin Faraj](https://github.com/robinfaraj/saas-boilerplate) + +### Examples +- [Stack Auth Example by career-tokens](https://github.com/career-tokens/StackYCAuth) +- [Stack Auth Demo by the Stack Auth team](https://github.com/stack-auth/stack-auth/tree/dev/examples/demo) +- [Stack Auth E-Commerce Example by the Stack Auth team](https://github.com/stack-auth/stack-auth/tree/dev/examples/e-commerce) + +## 🏗 Développement et contribution + +Cette section est pour vous si vous souhaitez contribuer au projet Stack Auth ou exécuter le tableau de bord Stack Auth localement. + +**Important** : Veuillez lire attentivement les [directives de contribution](CONTRIBUTING.md) et rejoindre [notre Discord](https://discord.stack-auth.com) si vous souhaitez aider. + +### Prérequis + +- Node v20 +- pnpm v9 +- Docker + +### Configuration + +Note : 24 Go+ de RAM sont recommandés pour une expérience de développement fluide. + +Dans un nouveau terminal : + +```sh +pnpm install + +# Compiler les paquets et générer le code. Nous n'avons besoin de faire cela qu'une seule fois, car `pnpm dev` s'en chargera désormais +pnpm build:packages +pnpm codegen + +# Démarrer les dépendances (BD, Inbucket, etc.) en tant que conteneurs Docker, en initialisant la BD avec le schéma Prisma +# Assurez-vous que Docker (ou OrbStack) est installé et en cours d'exécution +pnpm restart-deps + +# Démarrer le serveur de développement +pnpm dev + +# Dans un autre terminal, lancer les tests en mode watch +pnpm test # utile : --no-watch (désactive le mode watch) et --bail 1 (s'arrête après le premier échec) +``` + +Vous pouvez maintenant ouvrir le launchpad de développement à l'adresse [http://localhost:8100](http://localhost:8100). De là, vous pouvez naviguer vers le tableau de bord à [http://localhost:8101](http://localhost:8101), l'API sur le port 8102, la démo sur le port 8103, la documentation sur le port 8104, Inbucket (e-mails) sur le port 8105 et Prisma Studio sur le port 8106. Consultez le launchpad de développement pour la liste de tous les services en cours d'exécution. + +Votre IDE peut afficher une erreur sur tous les imports `@stackframe/XYZ`. Pour corriger cela, redémarrez simplement le serveur de langage TypeScript ; par exemple, dans VSCode vous pouvez ouvrir la palette de commandes (Ctrl+Shift+P) et exécuter `Developer: Reload Window` ou `TypeScript: Restart TS server`. + +Des fichiers .env pré-remplis pour la configuration ci-dessous sont disponibles et utilisés par défaut dans `.env.development` de chacun des paquets. Cependant, si vous créez un build de production (par ex. avec `pnpm run build`), vous devez fournir les variables d'environnement manuellement (voir ci-dessous). + +### Commandes utiles + +```sh +# NOTE : +# Veuillez consulter le launchpad de développement (par défaut : http://localhost:8100) pour la liste de tous les services en cours d'exécution. + +# Commandes d'installation +pnpm install : Installe les dépendances + +# Commandes de types et linting +pnpm typecheck : Exécute le vérificateur de types TypeScript. Peut nécessiter un build ou un serveur de développement en cours d'exécution. +pnpm lint : Exécute le linter ESLint. Optionnellement, passez `--fix` pour corriger certaines erreurs de linting. Peut nécessiter un build ou un serveur de développement en cours d'exécution. + +# Commandes de build +pnpm build : Compile tous les projets, y compris les applications, paquets, exemples et documentation. Exécute également les tâches de génération de code. Avant de pouvoir lancer ceci, vous devrez copier tous les fichiers `.env.development` des dossiers vers `.env.production.local` ou définir les variables d'environnement manuellement. +pnpm build:packages : Compile tous les paquets npm. +pnpm codegen : Exécute toutes les tâches de génération de code, par ex. la génération du client Prisma et de la documentation OpenAPI. + +# Commandes de développement +pnpm dev : Lance les serveurs de développement des projets principaux, excluant la plupart des exemples. Lors du premier lancement, nécessite que les paquets soient compilés et que codegen soit exécuté. Ensuite, il surveillera les modifications de fichiers (y compris ceux de génération de code). Si vous devez redémarrer le serveur de développement pour quelque raison que ce soit, c'est un bug que vous pouvez signaler. +pnpm dev:full : Lance les serveurs de développement pour tous les projets, y compris les exemples. +pnpm dev:basic : Lance les serveurs de développement uniquement pour les services nécessaires (backend et tableau de bord). Non recommandé pour la plupart des utilisateurs, mettez plutôt à niveau votre machine. + +# Commandes d'environnement +pnpm start-deps : Démarre les dépendances Docker (BD, Inbucket, etc.) en tant que conteneurs Docker, et les initialise avec le script seed et les migrations. Note : Les dépendances démarrées seront visibles sur le launchpad de développement (port 8100 par défaut). +pnpm stop-deps : Arrête les dépendances Docker (BD, Inbucket, etc.) et supprime leurs données. +pnpm restart-deps : Arrête et redémarre les dépendances. + +# Commandes de base de données +pnpm db:migration-gen : Actuellement non utilisé. Veuillez générer les migrations Prisma manuellement (ou avec l'IA). +pnpm db:reset : Réinitialise la base de données à son état initial. Exécuté automatiquement par `pnpm start-deps`. +pnpm db:init : Initialise la base de données avec le script seed et les migrations. Exécuté automatiquement par `pnpm db:reset`. +pnpm db:seed : Ré-initialise la base de données avec le script seed. Exécuté automatiquement par `pnpm db:init`. +pnpm db:migrate : Exécute les migrations. Exécuté automatiquement par `pnpm db:init`. + +# Commandes de test +pnpm test : Exécute les tests. Passez `--bail 1` pour que les tests s'arrêtent après le premier échec. Passez `--no-watch` pour exécuter les tests une seule fois au lieu du mode watch. + +# Commandes diverses +pnpm explain-query : Collez une requête SQL pour obtenir une explication du plan de requête, vous aidant à déboguer les problèmes de performance. +pnpm verify-data-integrity : Vérifie l'intégrité des données dans la base de données en exécutant une série de vérifications d'intégrité. Cela ne devrait jamais échouer à aucun moment (sauf si vous avez manipulé la BD manuellement). +``` + +Note : Lorsque vous travaillez avec l'IA, vous devriez garder un onglet de terminal avec le serveur de développement ouvert pour que l'IA puisse exécuter des requêtes contre celui-ci. + +## ❤ Contributeurs + + + + diff --git a/README.it.md b/README.it.md new file mode 100644 index 0000000000..29e2e7ea4b --- /dev/null +++ b/README.it.md @@ -0,0 +1,183 @@ +> Questa traduzione è stata generata da Claude. Se hai suggerimenti per migliorarla, le PR sono benvenute. + +[![Stack Logo](/.github/assets/logo.png)](https://stack-auth.com) + +

+ 📘 Documentazione + | ☁️ Versione Hosted + | ✨ Demo + | 🎮 Discord +

+ +

+ English | 繁體中文 | 简体中文 | 日本語 | 한국어 | Deutsch | Español | Français | Italiano | Português (Brasil) +

+ +# Stack Auth: La piattaforma di autenticazione open-source + +Stack Auth è una soluzione gestita per l'autenticazione degli utenti. È pensata per gli sviluppatori e completamente open-source (con licenza MIT e AGPL). + +Stack Auth ti permette di iniziare in soli cinque minuti, dopodiché sarai pronto a utilizzare tutte le sue funzionalità man mano che il tuo progetto cresce. Il nostro servizio gestito è completamente opzionale e puoi esportare i dati dei tuoi utenti e fare self-hosting, gratuitamente, in qualsiasi momento. + +Supportiamo frontend Next.js, React e JavaScript, insieme a qualsiasi backend che possa utilizzare la nostra [REST API](https://docs.stack-auth.com/api/overview). Consulta la nostra [guida alla configurazione](https://docs.stack-auth.com/docs/next/getting-started/setup) per iniziare. + +
+Stack Auth Setup +
+ +## In cosa è diverso da X? + +Chiediti riguardo a `X`: + +- `X` è open-source? +- `X` è pensato per gli sviluppatori, ben documentato e ti permette di iniziare in pochi minuti? +- Oltre all'autenticazione, `X` gestisce anche l'autorizzazione e la gestione degli utenti (vedi l'elenco delle funzionalità qui sotto)? + +Se hai risposto "no" a una qualsiasi di queste domande, ecco in cosa Stack Auth è diverso da `X`. + +## ✨ Funzionalità + +Per ricevere per primo le notifiche sulle nuove funzionalità, iscriviti alla [nostra newsletter](https://stack-auth.beehiiv.com/subscribe). + +| | | +|-|:-:| +|

`` e ``

Componenti di autenticazione che supportano OAuth, credenziali con password e magic link, con chiavi di sviluppo condivise per velocizzare la configurazione. Tutti i componenti supportano la modalità scura/chiara. | Sign-in component | +|

API idiomatiche per Next.js

Costruiamo su server component, React hook e route handler. | ![Dark/light mode](.github/assets/components.png) | +|

Dashboard utenti

Dashboard per filtrare, analizzare e modificare gli utenti. Sostituisce il primo strumento interno che avresti dovuto costruire. | ![User dashboard](.github/assets/dashboard.png) | +|

Impostazioni account

Permette agli utenti di aggiornare il proprio profilo, verificare la propria e-mail o cambiare la password. Nessuna configurazione necessaria. | Account settings component | +|

Multi-tenancy e team

Gestisci i clienti B2B con una struttura organizzativa logica e scalabile fino a milioni di utenti. | Selected team switcher component | +|

Controllo degli accessi basato sui ruoli

Definisci un grafo di permessi arbitrario e assegnalo agli utenti. Le organizzazioni possono creare ruoli specifici per la propria organizzazione. | RBAC | +|

Connessioni OAuth

Oltre al login, Stack Auth può anche gestire i token di accesso per API di terze parti, come Outlook e Google Calendar. Gestisce il rinnovo dei token e il controllo degli scope, rendendo i token di accesso accessibili tramite una singola chiamata di funzione. | OAuth tokens | +|

Passkey

Supporto per l'autenticazione senza password tramite passkey, che consente agli utenti di accedere in modo sicuro con dati biometrici o chiavi di sicurezza su tutti i loro dispositivi. | OAuth tokens | +|

Impersonificazione

Impersona gli utenti per il debug e il supporto, accedendo al loro account come se fossi loro. | Webhooks | +|

Webhook

Ricevi notifiche quando gli utenti utilizzano il tuo prodotto, basato su Svix. | Webhooks | +|

Email automatiche

Invia email personalizzabili in risposta a eventi come la registrazione, il reset della password e la verifica dell'email, modificabili con un editor WYSIWYG. | Email templates | +|

Gestione sessioni utente e JWT

Stack Auth gestisce refresh e access token, JWT e cookie, garantendo le migliori prestazioni senza costi di implementazione. | User button | +|

Autenticazione M2M

Usa token di accesso a breve durata per autenticare le tue macchine con altre macchine. | M2M authentication | + + +## 📦 Installazione e configurazione + +Per installare Stack Auth nel tuo progetto Next.js (per React, JavaScript o altri framework, consulta la nostra [documentazione completa](https://docs.stack-auth.com)): + +1. Esegui la procedura guidata di installazione di Stack Auth con il seguente comando: + ```bash + npx @stackframe/stack-cli@latest init + ``` + +2. Quindi, crea un account sulla [dashboard di Stack Auth](https://app.stack-auth.com/projects), crea un nuovo progetto con una chiave API e copia le variabili d'ambiente nel file .env.local del tuo progetto Next.js: + ``` + NEXT_PUBLIC_STACK_PROJECT_ID= + NEXT_PUBLIC_STACK_PUBLISHABLE_CLIENT_KEY= + STACK_SECRET_SERVER_KEY= + ``` +3. Ecco fatto! Puoi avviare la tua app con `npm run dev` e andare su [http://localhost:3000/handler/signup](http://localhost:3000/handler/signup) per vedere la pagina di registrazione. Puoi anche consultare la pagina delle impostazioni dell'account su [http://localhost:3000/handler/account-settings](http://localhost:3000/handler/account-settings). + +Consulta la [documentazione](https://docs.stack-auth.com/getting-started/setup) per una guida più dettagliata. + +## 🌱 Alcuni progetti della community realizzati con Stack Auth + +Hai il tuo progetto? Saremo felici di includerlo se crei una PR o ci scrivi su [Discord](https://discord.stack-auth.com). + +### Templates +- [Stack Auth Template by Stack Auth Team](https://github.com/stack-auth/stack-auth-template) +- [Next SaaSkit by wolfgunblood](https://github.com/wolfgunblood/nextjs-saaskit) +- [SaaS Boilerplate by Robin Faraj](https://github.com/robinfaraj/saas-boilerplate) + +### Examples +- [Stack Auth Example by career-tokens](https://github.com/career-tokens/StackYCAuth) +- [Stack Auth Demo by the Stack Auth team](https://github.com/stack-auth/stack-auth/tree/dev/examples/demo) +- [Stack Auth E-Commerce Example by the Stack Auth team](https://github.com/stack-auth/stack-auth/tree/dev/examples/e-commerce) + +## 🏗 Sviluppo e contributi + +Questa sezione è per te se vuoi contribuire al progetto Stack Auth o eseguire la dashboard di Stack Auth in locale. + +**Importante**: leggi attentamente le [linee guida per i contributi](CONTRIBUTING.md) e unisciti al [nostro Discord](https://discord.stack-auth.com) se vuoi aiutare. + +### Requisiti + +- Node v20 +- pnpm v9 +- Docker + +### Configurazione + +Nota: sono consigliati 24GB+ di RAM per un'esperienza di sviluppo fluida. + +In un nuovo terminale: + +```sh +pnpm install + +# Compila i pacchetti e genera il codice. Dobbiamo farlo solo una volta, poiché `pnpm dev` lo farà da ora in poi +pnpm build:packages +pnpm codegen + +# Avvia le dipendenze (DB, Inbucket, ecc.) come container Docker, inizializzando il DB con lo schema Prisma +# Assicurati di avere Docker (o OrbStack) installato e in esecuzione +pnpm restart-deps + +# Avvia il server di sviluppo +pnpm dev + +# In un altro terminale, esegui i test in modalità watch +pnpm test # utile: --no-watch (disabilita la modalità watch) e --bail 1 (si ferma dopo il primo errore) +``` + +Ora puoi aprire il launchpad di sviluppo su [http://localhost:8100](http://localhost:8100). Da lì, puoi navigare alla dashboard su [http://localhost:8101](http://localhost:8101), all'API sulla porta 8102, alla demo sulla porta 8103, alla documentazione sulla porta 8104, a Inbucket (e-mail) sulla porta 8105 e a Prisma Studio sulla porta 8106. Consulta il launchpad di sviluppo per un elenco di tutti i servizi in esecuzione. + +Il tuo IDE potrebbe mostrare un errore su tutti gli import `@stackframe/XYZ`. Per risolvere, riavvia semplicemente il server del linguaggio TypeScript; ad esempio, in VSCode puoi aprire la palette dei comandi (Ctrl+Shift+P) ed eseguire `Developer: Reload Window` o `TypeScript: Restart TS server`. + +I file .env precompilati per la configurazione seguente sono disponibili e utilizzati per impostazione predefinita in `.env.development` in ciascuno dei pacchetti. Tuttavia, se stai creando una build di produzione (ad es. con `pnpm run build`), devi fornire le variabili d'ambiente manualmente (vedi sotto). + +### Comandi utili + +```sh +# NOTA: +# Consulta il launchpad di sviluppo (default: http://localhost:8100) per un elenco di tutti i servizi in esecuzione. + +# Comandi di installazione +pnpm install: Installa le dipendenze + +# Comandi per tipi e linting +pnpm typecheck: Esegue il controllo dei tipi TypeScript. Potrebbe richiedere una build o un server di sviluppo in esecuzione. +pnpm lint: Esegue il linter ESLint. Opzionalmente, passa `--fix` per correggere alcuni errori di linting. Potrebbe richiedere una build o un server di sviluppo in esecuzione. + +# Comandi di build +pnpm build: Compila tutti i progetti, incluse app, pacchetti, esempi e documentazione. Esegue anche le attività di generazione del codice. Prima di eseguirlo, dovrai copiare tutti i file `.env.development` nelle cartelle in `.env.production.local` o impostare le variabili d'ambiente manualmente. +pnpm build:packages: Compila tutti i pacchetti npm. +pnpm codegen: Esegue tutte le attività di generazione del codice, ad es. la generazione del client Prisma e della documentazione OpenAPI. + +# Comandi di sviluppo +pnpm dev: Avvia i server di sviluppo dei progetti principali, escludendo la maggior parte degli esempi. Alla prima esecuzione, richiede che i pacchetti siano compilati e il codegen sia stato eseguito. Successivamente, controllerà le modifiche ai file (inclusi quelli di generazione del codice). Se devi riavviare il server di sviluppo per qualsiasi motivo, è un bug che puoi segnalare. +pnpm dev:full: Avvia i server di sviluppo per tutti i progetti, inclusi gli esempi. +pnpm dev:basic: Avvia i server di sviluppo solo per i servizi necessari (backend e dashboard). Non consigliato per la maggior parte degli utenti, piuttosto aggiorna la tua macchina. + +# Comandi per l'ambiente +pnpm start-deps: Avvia le dipendenze Docker (DB, Inbucket, ecc.) come container Docker e le inizializza con lo script di seed e le migrazioni. Nota: le dipendenze avviate saranno visibili nel launchpad di sviluppo (porta 8100 per impostazione predefinita). +pnpm stop-deps: Ferma le dipendenze Docker (DB, Inbucket, ecc.) e cancella i dati associati. +pnpm restart-deps: Ferma e riavvia le dipendenze. + +# Comandi per il database +pnpm db:migration-gen: Attualmente non utilizzato. Genera le migrazioni Prisma manualmente (o con l'AI). +pnpm db:reset: Resetta il database allo stato iniziale. Eseguito automaticamente da `pnpm start-deps`. +pnpm db:init: Inizializza il database con lo script di seed e le migrazioni. Eseguito automaticamente da `pnpm db:reset`. +pnpm db:seed: Re-esegue il seed del database con lo script di seed. Eseguito automaticamente da `pnpm db:init`. +pnpm db:migrate: Esegue le migrazioni. Eseguito automaticamente da `pnpm db:init`. + +# Comandi di test +pnpm test : Esegue i test. Passa `--bail 1` per far eseguire i test solo fino al primo errore. Passa `--no-watch` per eseguire i test una sola volta anziché in modalità watch. + +# Comandi vari +pnpm explain-query: Incolla una query SQL per ottenere una spiegazione del piano di query, utile per il debug dei problemi di prestazioni. +pnpm verify-data-integrity: Verifica l'integrità dei dati nel database eseguendo una serie di controlli. Questo non dovrebbe mai fallire in nessun momento (a meno che tu non abbia modificato il DB manualmente). +``` + +Nota: quando lavori con l'AI, dovresti tenere aperta una scheda del terminale con il server di sviluppo in modo che l'AI possa eseguire query su di esso. + +## ❤ Contributori + + + + diff --git a/README.ja.md b/README.ja.md new file mode 100644 index 0000000000..23fb6c5bb1 --- /dev/null +++ b/README.ja.md @@ -0,0 +1,183 @@ +> この翻訳は Claude によって生成されました。改善のご提案がありましたら、PR の作成を歓迎します。 + +[![Stack Logo](/.github/assets/logo.png)](https://stack-auth.com) + +

+ 📘 ドキュメント + | ☁️ ホスティング版 + | ✨ デモ + | 🎮 Discord +

+ +

+ English | 繁體中文 | 简体中文 | 日本語 | 한국어 | Deutsch | Español | Français | Italiano | Português (Brasil) +

+ +# Stack Auth: オープンソースの認証プラットフォーム + +Stack Auth はマネージドユーザー認証ソリューションです。開発者にとって使いやすく、完全にオープンソースです（MIT および AGPL ライセンス）。 + +Stack Auth はわずか5分で導入でき、プロジェクトの成長に合わせてすべての機能をすぐに利用できます。マネージドサービスは完全にオプションであり、ユーザーデータをエクスポートしていつでも無料でセルフホストできます。 + +Next.js、React、JavaScript のフロントエンドに対応しており、[REST API](https://docs.stack-auth.com/api/overview) を使用できるあらゆるバックエンドでも利用可能です。[セットアップガイド](https://docs.stack-auth.com/docs/next/getting-started/setup)をご覧ください。 + +
+Stack Auth Setup +
+ +## X との違いは？ + +`X` について以下の質問を考えてみてください： + +- `X` はオープンソースですか？ +- `X` は開発者にとって使いやすく、ドキュメントが充実しており、数分で始められますか？ +- 認証だけでなく、`X` は認可やユーザー管理もできますか（以下の機能一覧を参照）？ + +いずれかの質問に「いいえ」と答えた場合、それが Stack Auth と `X` の違いです。 + +## ✨ 機能 + +新機能の追加をいち早く知りたい方は、[ニュースレター](https://stack-auth.beehiiv.com/subscribe)にご登録ください。 + +| | | +|-|:-:| +|

`` と ``

OAuth、パスワード認証、マジックリンクに対応した認証コンポーネント。セットアップを高速化する共有開発キー付き。すべてのコンポーネントがダーク/ライトモードに対応しています。 | Sign-in component | +|

慣用的な Next.js API

サーバーコンポーネント、React フック、ルートハンドラーを活用して構築されています。 | ![Dark/light mode](.github/assets/components.png) | +|

ユーザーダッシュボード

ユーザーのフィルタリング、分析、編集ができるダッシュボード。最初に構築しなければならない内部ツールの代わりになります。 | ![User dashboard](.github/assets/dashboard.png) | +|

アカウント設定

ユーザーがプロフィールの更新、メールアドレスの確認、パスワードの変更を行えます。セットアップ不要です。 | Account settings component | +|

マルチテナンシーとチーム

合理的で数百万規模までスケールする組織構造で B2B 顧客を管理できます。 | Selected team switcher component | +|

ロールベースアクセス制御

任意の権限グラフを定義してユーザーに割り当てられます。組織は組織固有のロールを作成できます。 | RBAC | +|

OAuth 接続

ログインだけでなく、Stack Auth は Outlook や Google Calendar などのサードパーティ API のアクセストークンも管理できます。トークンの更新とスコープの制御を処理し、1つの関数呼び出しでアクセストークンを利用できます。 | OAuth tokens | +|

パスキー

パスキーによるパスワードレス認証に対応しており、ユーザーはすべてのデバイスで生体認証やセキュリティキーを使って安全にサインインできます。 | OAuth tokens | +|

なりすまし

デバッグやサポートのためにユーザーになりすまし、そのユーザーとしてアカウントにログインできます。 | Webhooks | +|

Webhook

Svix 上に構築されており、ユーザーがプロダクトを利用した際に通知を受け取れます。 | Webhooks | +|

自動メール

サインアップ、パスワードリセット、メール確認などのトリガーでカスタマイズ可能なメールを送信でき、WYSIWYG エディタで編集できます。 | Email templates | +|

ユーザーセッションと JWT 処理

Stack Auth はリフレッシュトークンとアクセストークン、JWT、Cookie を管理し、実装コストなしで最高のパフォーマンスを実現します。 | User button | +|

M2M 認証

短期間有効なアクセストークンを使用して、マシン間の認証を行います。 | M2M authentication | + + +## 📦 インストールとセットアップ + +Next.js プロジェクトに Stack Auth をインストールするには（React、JavaScript、その他のフレームワークについては[完全なドキュメント](https://docs.stack-auth.com)をご覧ください）： + +1. 以下のコマンドで Stack Auth のインストールウィザードを実行します： + ```bash + npx @stackframe/stack-cli@latest init + ``` + +2. 次に、[Stack Auth ダッシュボード](https://app.stack-auth.com/projects)でアカウントを作成し、API キー付きの新しいプロジェクトを作成して、その環境変数を Next.js プロジェクトの .env.local ファイルにコピーします： + ``` + NEXT_PUBLIC_STACK_PROJECT_ID= + NEXT_PUBLIC_STACK_PUBLISHABLE_CLIENT_KEY= + STACK_SECRET_SERVER_KEY= + ``` +3. 以上です！`npm run dev` でアプリを実行し、[http://localhost:3000/handler/signup](http://localhost:3000/handler/signup) にアクセスしてサインアップページを確認できます。また、[http://localhost:3000/handler/account-settings](http://localhost:3000/handler/account-settings) でアカウント設定ページも確認できます。 + +より詳細なガイドは[ドキュメント](https://docs.stack-auth.com/getting-started/setup)をご覧ください。 + +## 🌱 Stack Auth を使ったコミュニティプロジェクト + +自分のプロジェクトがありますか？PR を作成するか [Discord](https://discord.stack-auth.com) でメッセージをいただければ、喜んで掲載します。 + +### Templates +- [Stack Auth Template by Stack Auth Team](https://github.com/stack-auth/stack-auth-template) +- [Next SaaSkit by wolfgunblood](https://github.com/wolfgunblood/nextjs-saaskit) +- [SaaS Boilerplate by Robin Faraj](https://github.com/robinfaraj/saas-boilerplate) + +### Examples +- [Stack Auth Example by career-tokens](https://github.com/career-tokens/StackYCAuth) +- [Stack Auth Demo by the Stack Auth team](https://github.com/stack-auth/stack-auth/tree/dev/examples/demo) +- [Stack Auth E-Commerce Example by the Stack Auth team](https://github.com/stack-auth/stack-auth/tree/dev/examples/e-commerce) + +## 🏗 開発と貢献 + +Stack Auth プロジェクトに貢献したい方や、Stack Auth ダッシュボードをローカルで実行したい方向けのセクションです。 + +**重要**: [貢献ガイドライン](CONTRIBUTING.md)をよくお読みいただき、協力いただける場合は [Discord](https://discord.stack-auth.com) にご参加ください。 + +### 必要環境 + +- Node v20 +- pnpm v9 +- Docker + +### セットアップ + +注意: 快適な開発体験のために 24GB 以上の RAM を推奨します。 + +新しいターミナルで： + +```sh +pnpm install + +# パッケージのビルドとコード生成。これは一度だけ実行すればよく、以降は `pnpm dev` が自動で行います +pnpm build:packages +pnpm codegen + +# 依存関係（DB、Inbucket など）を Docker コンテナとして起動し、Prisma スキーマで DB をシードします +# Docker（または OrbStack）がインストールされ、実行中であることを確認してください +pnpm restart-deps + +# 開発サーバーを起動 +pnpm dev + +# 別のターミナルでウォッチモードでテストを実行 +pnpm test # 便利なオプション: --no-watch（ウォッチモード無効）と --bail 1（最初の失敗で停止） +``` + +[http://localhost:8100](http://localhost:8100) で開発ランチパッドを開けます。そこから、[http://localhost:8101](http://localhost:8101) のダッシュボード、ポート 8102 の API、ポート 8103 のデモ、ポート 8104 のドキュメント、ポート 8105 の Inbucket（メール）、ポート 8106 の Prisma Studio にアクセスできます。実行中のすべてのサービスの一覧は開発ランチパッドをご覧ください。 + +IDE で `@stackframe/XYZ` のインポートにエラーが表示される場合があります。これを修正するには、TypeScript 言語サーバーを再起動してください。例えば VSCode では、コマンドパレット（Ctrl+Shift+P）を開いて `Developer: Reload Window` または `TypeScript: Restart TS server` を実行します。 + +以下のセットアップ用の事前設定済み .env ファイルが利用可能で、各パッケージの `.env.development` にデフォルトで使用されます。ただし、プロダクションビルド（例：`pnpm run build`）を作成する場合は、環境変数を手動で設定する必要があります（以下参照）。 + +### 便利なコマンド + +```sh +# 注意: +# 実行中のすべてのサービスの一覧は開発ランチパッド（デフォルト: http://localhost:8100）をご覧ください。 + +# インストールコマンド +pnpm install: 依存関係をインストール + +# 型チェックとリントコマンド +pnpm typecheck: TypeScript の型チェッカーを実行。先にビルドまたは開発サーバーの起動が必要な場合があります。 +pnpm lint: ESLint リンターを実行。オプションで `--fix` を渡すとリントエラーの一部を修正できます。先にビルドまたは開発サーバーの起動が必要な場合があります。 + +# ビルドコマンド +pnpm build: アプリ、パッケージ、サンプル、ドキュメントを含むすべてのプロジェクトをビルドします。コード生成タスクも実行されます。実行前に、各フォルダの `.env.development` ファイルを `.env.production.local` にコピーするか、環境変数を手動で設定する必要があります。 +pnpm build:packages: すべての npm パッケージをビルドします。 +pnpm codegen: Prisma クライアントや OpenAPI ドキュメント生成などのすべてのコード生成タスクを実行します。 + +# 開発コマンド +pnpm dev: メインプロジェクトの開発サーバーを実行します（ほとんどのサンプルは除く）。初回実行時はパッケージのビルドとコード生成が必要です。その後はファイルの変更（コード生成ファイルを含む）を監視します。開発サーバーの再起動が必要な場合、それはバグとして報告できます。 +pnpm dev:full: サンプルを含むすべてのプロジェクトの開発サーバーを実行します。 +pnpm dev:basic: 必要なサービス（バックエンドとダッシュボード）のみの開発サーバーを実行します。ほとんどのユーザーには推奨しません。マシンのアップグレードを検討してください。 + +# 環境コマンド +pnpm start-deps: 依存関係（DB、Inbucket など）を Docker コンテナとして起動し、シードスクリプトとマイグレーションで初期化します。注意: 起動された依存関係は開発ランチパッド（デフォルトでポート 8100）に表示されます。 +pnpm stop-deps: 依存関係（DB、Inbucket など）を停止し、データを削除します。 +pnpm restart-deps: 依存関係を停止して再起動します。 + +# データベースコマンド +pnpm db:migration-gen: 現在未使用。Prisma マイグレーションは手動（または AI を使って）生成してください。 +pnpm db:reset: データベースを初期状態にリセットします。`pnpm start-deps` で自動実行されます。 +pnpm db:init: シードスクリプトとマイグレーションでデータベースを初期化します。`pnpm db:reset` で自動実行されます。 +pnpm db:seed: シードスクリプトでデータベースを再シードします。`pnpm db:init` で自動実行されます。 +pnpm db:migrate: マイグレーションを実行します。`pnpm db:init` で自動実行されます。 + +# テストコマンド +pnpm test : テストを実行します。`--bail 1` を渡すと最初の失敗で停止します。`--no-watch` を渡すとウォッチモードではなく一度だけ実行します。 + +# その他のコマンド +pnpm explain-query: SQL クエリを貼り付けるとクエリプランの説明が得られ、パフォーマンスの問題をデバッグできます。 +pnpm verify-data-integrity: 一連の整合性チェックを実行して、データベース内のデータの整合性を検証します。（手動で DB を操作しない限り）いかなる時点でも失敗しないはずです。 +``` + +注意: AI と作業する場合は、AI がクエリを実行できるよう、開発サーバーが起動しているターミナルタブを開いておくことをお勧めします。 + +## ❤ コントリビューター + + + + diff --git a/README.ko.md b/README.ko.md new file mode 100644 index 0000000000..7a4df98c6e --- /dev/null +++ b/README.ko.md @@ -0,0 +1,183 @@ +> 이 번역은 Claude에 의해 생성되었습니다. 개선 제안이 있으시면 PR을 보내주세요. + +[![Stack Logo](/.github/assets/logo.png)](https://stack-auth.com) + +

+ 📘 문서 + | ☁️ 호스팅 버전 + | ✨ 데모 + | 🎮 Discord +

+ +

+ English | 繁體中文 | 简体中文 | 日本語 | 한국어 | Deutsch | Español | Français | Italiano | Português (Brasil) +

+ +# Stack Auth: 오픈소스 인증 플랫폼 + +Stack Auth는 매니지드 사용자 인증 솔루션입니다. 개발자 친화적이며 완전한 오픈소스입니다(MIT 및 AGPL 라이선스). + +Stack Auth는 단 5분 만에 시작할 수 있으며, 프로젝트가 성장함에 따라 모든 기능을 바로 사용할 수 있습니다. 매니지드 서비스는 완전히 선택 사항이며, 사용자 데이터를 내보내고 언제든지 무료로 셀프 호스팅할 수 있습니다. + +Next.js, React, JavaScript 프론트엔드를 지원하며, [REST API](https://docs.stack-auth.com/api/overview)를 사용할 수 있는 모든 백엔드에서도 이용 가능합니다. [설정 가이드](https://docs.stack-auth.com/docs/next/getting-started/setup)를 확인하여 시작하세요. + +
+Stack Auth Setup +
+ +## X와 어떻게 다른가요? + +`X`에 대해 다음 질문들을 생각해 보세요: + +- `X`는 오픈소스인가요? +- `X`는 개발자 친화적이고, 문서가 잘 되어 있으며, 몇 분 만에 시작할 수 있나요? +- 인증 외에도 `X`는 인가와 사용자 관리도 지원하나요(아래 기능 목록 참조)? + +이 질문 중 하나라도 "아니오"라고 답했다면, 그것이 Stack Auth와 `X`의 차이점입니다. + +## ✨ 기능 + +새로운 기능이 추가될 때 가장 먼저 알림을 받으려면 [뉴스레터](https://stack-auth.beehiiv.com/subscribe)를 구독해 주세요. + +| | | +|-|:-:| +|

``과 ``

OAuth, 비밀번호 인증, 매직 링크를 지원하는 인증 컴포넌트. 설정을 빠르게 할 수 있는 공유 개발 키 포함. 모든 컴포넌트가 다크/라이트 모드를 지원합니다. | Sign-in component | +|

관용적인 Next.js API

서버 컴포넌트, React 훅, 라우트 핸들러를 기반으로 구축되었습니다. | ![Dark/light mode](.github/assets/components.png) | +|

사용자 대시보드

사용자를 필터링, 분석, 편집할 수 있는 대시보드. 처음으로 만들어야 했을 내부 도구를 대체합니다. | ![User dashboard](.github/assets/dashboard.png) | +|

계정 설정

사용자가 프로필 업데이트, 이메일 인증, 비밀번호 변경을 할 수 있습니다. 별도의 설정이 필요 없습니다. | Account settings component | +|

멀티테넌시와 팀

합리적이고 수백만 규모까지 확장 가능한 조직 구조로 B2B 고객을 관리합니다. | Selected team switcher component | +|

역할 기반 접근 제어

임의의 권한 그래프를 정의하고 사용자에게 할당할 수 있습니다. 조직은 조직별 역할을 생성할 수 있습니다. | RBAC | +|

OAuth 연결

로그인 외에도 Stack Auth는 Outlook 및 Google Calendar와 같은 서드파티 API의 액세스 토큰도 관리할 수 있습니다. 토큰 갱신과 스코프 제어를 처리하며, 단일 함수 호출로 액세스 토큰을 사용할 수 있습니다. | OAuth tokens | +|

패스키

패스키를 사용한 비밀번호 없는 인증을 지원하여, 사용자가 모든 기기에서 생체 인식이나 보안 키로 안전하게 로그인할 수 있습니다. | OAuth tokens | +|

사용자 가장

디버깅과 지원을 위해 사용자를 가장하여 해당 사용자로 계정에 로그인할 수 있습니다. | Webhooks | +|

Webhook

Svix 기반으로 구축되어 사용자가 제품을 사용할 때 알림을 받을 수 있습니다. | Webhooks | +|

자동 이메일

가입, 비밀번호 재설정, 이메일 인증 등의 트리거에 맞춤형 이메일을 전송하며, WYSIWYG 에디터로 편집할 수 있습니다. | Email templates | +|

사용자 세션 및 JWT 처리

Stack Auth는 리프레시 토큰과 액세스 토큰, JWT, 쿠키를 관리하여 구현 비용 없이 최상의 성능을 제공합니다. | User button | +|

M2M 인증

수명이 짧은 액세스 토큰을 사용하여 머신 간 인증을 수행합니다. | M2M authentication | + + +## 📦 설치 및 설정 + +Next.js 프로젝트에 Stack Auth를 설치하려면 (React, JavaScript 또는 기타 프레임워크는 [전체 문서](https://docs.stack-auth.com)를 참조하세요): + +1. 다음 명령어로 Stack Auth 설치 마법사를 실행합니다: + ```bash + npx @stackframe/stack-cli@latest init + ``` + +2. 그런 다음 [Stack Auth 대시보드](https://app.stack-auth.com/projects)에서 계정을 만들고, API 키가 포함된 새 프로젝트를 생성한 후, 환경 변수를 Next.js 프로젝트의 .env.local 파일에 복사합니다: + ``` + NEXT_PUBLIC_STACK_PROJECT_ID= + NEXT_PUBLIC_STACK_PUBLISHABLE_CLIENT_KEY= + STACK_SECRET_SERVER_KEY= + ``` +3. 이것으로 끝입니다! `npm run dev`로 앱을 실행하고 [http://localhost:3000/handler/signup](http://localhost:3000/handler/signup)에 접속하여 회원가입 페이지를 확인할 수 있습니다. [http://localhost:3000/handler/account-settings](http://localhost:3000/handler/account-settings)에서 계정 설정 페이지도 확인할 수 있습니다. + +더 자세한 가이드는 [문서](https://docs.stack-auth.com/getting-started/setup)를 확인하세요. + +## 🌱 Stack Auth로 만든 커뮤니티 프로젝트 + +본인의 프로젝트가 있으신가요? PR을 만들거나 [Discord](https://discord.stack-auth.com)에서 메시지를 보내주시면 기꺼이 소개하겠습니다. + +### Templates +- [Stack Auth Template by Stack Auth Team](https://github.com/stack-auth/stack-auth-template) +- [Next SaaSkit by wolfgunblood](https://github.com/wolfgunblood/nextjs-saaskit) +- [SaaS Boilerplate by Robin Faraj](https://github.com/robinfaraj/saas-boilerplate) + +### Examples +- [Stack Auth Example by career-tokens](https://github.com/career-tokens/StackYCAuth) +- [Stack Auth Demo by the Stack Auth team](https://github.com/stack-auth/stack-auth/tree/dev/examples/demo) +- [Stack Auth E-Commerce Example by the Stack Auth team](https://github.com/stack-auth/stack-auth/tree/dev/examples/e-commerce) + +## 🏗 개발 및 기여 + +Stack Auth 프로젝트에 기여하거나 Stack Auth 대시보드를 로컬에서 실행하고 싶은 분들을 위한 섹션입니다. + +**중요**: [기여 가이드라인](CONTRIBUTING.md)을 꼼꼼히 읽어주시고, 도움을 주고 싶으시면 [Discord](https://discord.stack-auth.com)에 참여해 주세요. + +### 요구 사항 + +- Node v20 +- pnpm v9 +- Docker + +### 설정 + +참고: 원활한 개발 경험을 위해 24GB 이상의 RAM을 권장합니다. + +새 터미널에서: + +```sh +pnpm install + +# 패키지 빌드 및 코드 생성. 이 작업은 한 번만 실행하면 되며, 이후에는 `pnpm dev`가 자동으로 수행합니다 +pnpm build:packages +pnpm codegen + +# 의존성(DB, Inbucket 등)을 Docker 컨테이너로 시작하고 Prisma 스키마로 DB를 시드합니다 +# Docker(또는 OrbStack)가 설치되어 실행 중인지 확인하세요 +pnpm restart-deps + +# 개발 서버 시작 +pnpm dev + +# 다른 터미널에서 워치 모드로 테스트 실행 +pnpm test # 유용한 옵션: --no-watch (워치 모드 비활성화) 및 --bail 1 (첫 번째 실패 시 중단) +``` + +[http://localhost:8100](http://localhost:8100)에서 개발 런치패드를 열 수 있습니다. 거기서 [http://localhost:8101](http://localhost:8101)의 대시보드, 포트 8102의 API, 포트 8103의 데모, 포트 8104의 문서, 포트 8105의 Inbucket(이메일), 포트 8106의 Prisma Studio로 이동할 수 있습니다. 실행 중인 모든 서비스 목록은 개발 런치패드를 참조하세요. + +IDE에서 모든 `@stackframe/XYZ` 임포트에 오류가 표시될 수 있습니다. 이를 해결하려면 TypeScript 언어 서버를 재시작하세요. 예를 들어 VSCode에서는 명령 팔레트(Ctrl+Shift+P)를 열고 `Developer: Reload Window` 또는 `TypeScript: Restart TS server`를 실행합니다. + +아래 설정을 위한 사전 구성된 .env 파일이 각 패키지의 `.env.development`에 기본적으로 사용되고 있습니다. 그러나 프로덕션 빌드(예: `pnpm run build`)를 생성하는 경우 환경 변수를 수동으로 제공해야 합니다(아래 참조). + +### 유용한 명령어 + +```sh +# 참고: +# 실행 중인 모든 서비스 목록은 개발 런치패드(기본: http://localhost:8100)를 참조하세요. + +# 설치 명령어 +pnpm install: 의존성 설치 + +# 타입 및 린트 명령어 +pnpm typecheck: TypeScript 타입 체커를 실행합니다. 먼저 빌드 또는 개발 서버 실행이 필요할 수 있습니다. +pnpm lint: ESLint 린터를 실행합니다. 선택적으로 `--fix`를 전달하여 일부 린트 오류를 수정할 수 있습니다. 먼저 빌드 또는 개발 서버 실행이 필요할 수 있습니다. + +# 빌드 명령어 +pnpm build: 앱, 패키지, 예제, 문서를 포함한 모든 프로젝트를 빌드합니다. 코드 생성 작업도 실행됩니다. 실행 전에 각 폴더의 `.env.development` 파일을 `.env.production.local`로 복사하거나 환경 변수를 수동으로 설정해야 합니다. +pnpm build:packages: 모든 npm 패키지를 빌드합니다. +pnpm codegen: Prisma 클라이언트 및 OpenAPI 문서 생성 등 모든 코드 생성 작업을 실행합니다. + +# 개발 명령어 +pnpm dev: 대부분의 예제를 제외한 메인 프로젝트의 개발 서버를 실행합니다. 첫 실행 시 패키지 빌드와 코드 생성이 필요합니다. 이후에는 파일 변경(코드 생성 파일 포함)을 감시합니다. 개발 서버를 재시작해야 하는 경우, 그것은 보고할 수 있는 버그입니다. +pnpm dev:full: 예제를 포함한 모든 프로젝트의 개발 서버를 실행합니다. +pnpm dev:basic: 필수 서비스(백엔드와 대시보드)만의 개발 서버를 실행합니다. 대부분의 사용자에게는 권장하지 않으며, 머신 업그레이드를 고려하세요. + +# 환경 명령어 +pnpm start-deps: 의존성(DB, Inbucket 등)을 Docker 컨테이너로 시작하고 시드 스크립트와 마이그레이션으로 초기화합니다. 참고: 시작된 의존성은 개발 런치패드(기본 포트 8100)에 표시됩니다. +pnpm stop-deps: 의존성(DB, Inbucket 등)을 중지하고 데이터를 삭제합니다. +pnpm restart-deps: 의존성을 중지하고 재시작합니다. + +# 데이터베이스 명령어 +pnpm db:migration-gen: 현재 사용되지 않습니다. Prisma 마이그레이션은 수동으로(또는 AI를 사용하여) 생성해 주세요. +pnpm db:reset: 데이터베이스를 초기 상태로 리셋합니다. `pnpm start-deps`에 의해 자동 실행됩니다. +pnpm db:init: 시드 스크립트와 마이그레이션으로 데이터베이스를 초기화합니다. `pnpm db:reset`에 의해 자동 실행됩니다. +pnpm db:seed: 시드 스크립트로 데이터베이스를 다시 시드합니다. `pnpm db:init`에 의해 자동 실행됩니다. +pnpm db:migrate: 마이그레이션을 실행합니다. `pnpm db:init`에 의해 자동 실행됩니다. + +# 테스트 명령어 +pnpm test : 테스트를 실행합니다. `--bail 1`을 전달하면 첫 번째 실패 시 중단됩니다. `--no-watch`를 전달하면 워치 모드 대신 한 번만 실행됩니다. + +# 기타 명령어 +pnpm explain-query: SQL 쿼리를 붙여넣으면 쿼리 플랜에 대한 설명을 받을 수 있어 성능 문제 디버깅에 도움이 됩니다. +pnpm verify-data-integrity: 일련의 무결성 검사를 실행하여 데이터베이스 데이터의 무결성을 확인합니다. (수동으로 DB를 조작하지 않는 한) 어느 시점에서도 실패하지 않아야 합니다. +``` + +참고: AI와 작업할 때는 AI가 쿼리를 실행할 수 있도록 개발 서버가 실행 중인 터미널 탭을 열어두는 것이 좋습니다. + +## ❤ 기여자 + + + + diff --git a/README.md b/README.md index c973eeb5a0..c366b7e188 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,10 @@ | 🎮 Discord +

+ English | 繁體中文 | 简体中文 | 日本語 | 한국어 | Deutsch | Español | Français | Italiano | Português (Brasil) +

+ # 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). diff --git a/README.pt-BR.md b/README.pt-BR.md new file mode 100644 index 0000000000..3ca0bcae68 --- /dev/null +++ b/README.pt-BR.md @@ -0,0 +1,183 @@ +> Esta tradução foi gerada pelo Claude. Sugestões de melhoria via PR são bem-vindas. + +[![Stack Logo](/.github/assets/logo.png)](https://stack-auth.com) + +

+ 📘 Documentação + | ☁️ Versão Hospedada + | ✨ Demo + | 🎮 Discord +

+ +

+ English | 繁體中文 | 简体中文 | 日本語 | 한국어 | Deutsch | Español | Français | Italiano | Português (Brasil) +

+ +# Stack Auth: A plataforma de autenticação open-source + +Stack Auth é uma solução gerenciada de autenticação de usuários. É voltada para desenvolvedores e totalmente open-source (licenciada sob MIT e AGPL). + +Stack Auth permite que você comece em apenas cinco minutos, após os quais você estará pronto para usar todos os seus recursos conforme seu projeto cresce. Nosso serviço gerenciado é completamente opcional e você pode exportar os dados dos seus usuários e fazer self-hosting, gratuitamente, a qualquer momento. + +Suportamos frontends Next.js, React e JavaScript, junto com qualquer backend que possa usar nossa [REST API](https://docs.stack-auth.com/api/overview). Confira nosso [guia de configuração](https://docs.stack-auth.com/docs/next/getting-started/setup) para começar. + +
+Stack Auth Setup +
+ +## Como isso é diferente de X? + +Pergunte a si mesmo sobre `X`: + +- `X` é open-source? +- `X` é voltado para desenvolvedores, bem documentado e permite que você comece em minutos? +- Além da autenticação, `X` também faz autorização e gerenciamento de usuários (veja a lista de recursos abaixo)? + +Se você respondeu "não" a qualquer uma dessas perguntas, é assim que Stack Auth é diferente de `X`. + +## ✨ Recursos + +Para ser notificado primeiro quando adicionarmos novos recursos, inscreva-se na [nossa newsletter](https://stack-auth.beehiiv.com/subscribe). + +| | | +|-|:-:| +|

`` e ``

Componentes de autenticação que suportam OAuth, credenciais com senha e magic links, com chaves de desenvolvimento compartilhadas para acelerar a configuração. Todos os componentes suportam modo escuro/claro. | Sign-in component | +|

APIs idiomáticas para Next.js

Construímos sobre server components, React hooks e route handlers. | ![Dark/light mode](.github/assets/components.png) | +|

Dashboard de usuários

Dashboard para filtrar, analisar e editar usuários. Substitui a primeira ferramenta interna que você teria que construir. | ![User dashboard](.github/assets/dashboard.png) | +|

Configurações da conta

Permite que os usuários atualizem seu perfil, verifiquem seu e-mail ou alterem sua senha. Nenhuma configuração necessária. | Account settings component | +|

Multi-tenancy e equipes

Gerencie clientes B2B com uma estrutura organizacional que faz sentido e escala para milhões. | Selected team switcher component | +|

Controle de acesso baseado em funções

Defina um grafo de permissões arbitrário e atribua-o aos usuários. As organizações podem criar funções específicas para sua organização. | RBAC | +|

Conexões OAuth

Além do login, Stack Auth também pode gerenciar tokens de acesso para APIs de terceiros, como Outlook e Google Calendar. Gerencia a renovação de tokens e o controle de escopo, tornando os tokens de acesso acessíveis por meio de uma única chamada de função. | OAuth tokens | +|

Passkeys

Suporte para autenticação sem senha usando passkeys, permitindo que os usuários façam login com segurança usando biometria ou chaves de segurança em todos os seus dispositivos. | OAuth tokens | +|

Personificação

Personifique usuários para depuração e suporte, fazendo login na conta deles como se fosse você. | Webhooks | +|

Webhooks

Receba notificações quando os usuários usam seu produto, construído sobre Svix. | Webhooks | +|

E-mails automáticos

Envie e-mails personalizáveis em resposta a eventos como cadastro, redefinição de senha e verificação de e-mail, editáveis com um editor WYSIWYG. | Email templates | +|

Gerenciamento de sessões de usuário e JWT

Stack Auth gerencia refresh e access tokens, JWTs e cookies, resultando no melhor desempenho sem custo de implementação. | User button | +|

Autenticação M2M

Use tokens de acesso de curta duração para autenticar suas máquinas com outras máquinas. | M2M authentication | + + +## 📦 Instalação e configuração + +Para instalar Stack Auth no seu projeto Next.js (para React, JavaScript ou outros frameworks, consulte nossa [documentação completa](https://docs.stack-auth.com)): + +1. Execute o assistente de instalação do Stack Auth com o seguinte comando: + ```bash + npx @stackframe/stack-cli@latest init + ``` + +2. Em seguida, crie uma conta no [dashboard do Stack Auth](https://app.stack-auth.com/projects), crie um novo projeto com uma chave de API e copie as variáveis de ambiente para o arquivo .env.local do seu projeto Next.js: + ``` + NEXT_PUBLIC_STACK_PROJECT_ID= + NEXT_PUBLIC_STACK_PUBLISHABLE_CLIENT_KEY= + STACK_SECRET_SERVER_KEY= + ``` +3. Pronto! Você pode executar sua aplicação com `npm run dev` e acessar [http://localhost:3000/handler/signup](http://localhost:3000/handler/signup) para ver a página de cadastro. Você também pode conferir a página de configurações da conta em [http://localhost:3000/handler/account-settings](http://localhost:3000/handler/account-settings). + +Consulte a [documentação](https://docs.stack-auth.com/getting-started/setup) para um guia mais detalhado. + +## 🌱 Alguns projetos da comunidade construídos com Stack Auth + +Tem o seu próprio? Ficaremos felizes em incluí-lo se você criar uma PR ou nos enviar uma mensagem no [Discord](https://discord.stack-auth.com). + +### Templates +- [Stack Auth Template by Stack Auth Team](https://github.com/stack-auth/stack-auth-template) +- [Next SaaSkit by wolfgunblood](https://github.com/wolfgunblood/nextjs-saaskit) +- [SaaS Boilerplate by Robin Faraj](https://github.com/robinfaraj/saas-boilerplate) + +### Examples +- [Stack Auth Example by career-tokens](https://github.com/career-tokens/StackYCAuth) +- [Stack Auth Demo by the Stack Auth team](https://github.com/stack-auth/stack-auth/tree/dev/examples/demo) +- [Stack Auth E-Commerce Example by the Stack Auth team](https://github.com/stack-auth/stack-auth/tree/dev/examples/e-commerce) + +## 🏗 Desenvolvimento e contribuição + +Esta seção é para você se deseja contribuir com o projeto Stack Auth ou executar o dashboard do Stack Auth localmente. + +**Importante**: leia atentamente as [diretrizes de contribuição](CONTRIBUTING.md) e entre no [nosso Discord](https://discord.stack-auth.com) se quiser ajudar. + +### Requisitos + +- Node v20 +- pnpm v9 +- Docker + +### Configuração + +Nota: 24GB+ de RAM são recomendados para uma experiência de desenvolvimento fluida. + +Em um novo terminal: + +```sh +pnpm install + +# Compile os pacotes e gere o código. Precisamos fazer isso apenas uma vez, pois `pnpm dev` fará isso a partir de agora +pnpm build:packages +pnpm codegen + +# Inicie as dependências (DB, Inbucket, etc.) como containers Docker, inicializando o DB com o schema do Prisma +# Certifique-se de que o Docker (ou OrbStack) esteja instalado e em execução +pnpm restart-deps + +# Inicie o servidor de desenvolvimento +pnpm dev + +# Em outro terminal, execute os testes em modo watch +pnpm test # útil: --no-watch (desativa o modo watch) e --bail 1 (para após a primeira falha) +``` + +Agora você pode abrir o launchpad de desenvolvimento em [http://localhost:8100](http://localhost:8100). De lá, você pode navegar até o dashboard em [http://localhost:8101](http://localhost:8101), API na porta 8102, demo na porta 8103, documentação na porta 8104, Inbucket (e-mails) na porta 8105 e Prisma Studio na porta 8106. Consulte o launchpad de desenvolvimento para uma lista de todos os serviços em execução. + +Seu IDE pode mostrar um erro em todos os imports `@stackframe/XYZ`. Para corrigir isso, basta reiniciar o servidor de linguagem TypeScript; por exemplo, no VSCode você pode abrir a paleta de comandos (Ctrl+Shift+P) e executar `Developer: Reload Window` ou `TypeScript: Restart TS server`. + +Arquivos .env pré-populados para a configuração abaixo estão disponíveis e são usados por padrão em `.env.development` em cada um dos pacotes. No entanto, se você estiver criando uma build de produção (ex.: com `pnpm run build`), deve fornecer as variáveis de ambiente manualmente (veja abaixo). + +### Comandos úteis + +```sh +# NOTA: +# Consulte o launchpad de desenvolvimento (padrão: http://localhost:8100) para uma lista de todos os serviços em execução. + +# Comandos de instalação +pnpm install: Instala as dependências + +# Comandos de tipos e linting +pnpm typecheck: Executa a verificação de tipos do TypeScript. Pode exigir uma build ou servidor de desenvolvimento em execução. +pnpm lint: Executa o linter ESLint. Opcionalmente, passe `--fix` para corrigir alguns erros de linting. Pode exigir uma build ou servidor de desenvolvimento em execução. + +# Comandos de build +pnpm build: Compila todos os projetos, incluindo apps, pacotes, exemplos e documentação. Também executa tarefas de geração de código. Antes de executar, você precisará copiar todos os arquivos `.env.development` nas pastas para `.env.production.local` ou definir as variáveis de ambiente manualmente. +pnpm build:packages: Compila todos os pacotes npm. +pnpm codegen: Executa todas as tarefas de geração de código, ex.: geração do cliente Prisma e da documentação OpenAPI. + +# Comandos de desenvolvimento +pnpm dev: Executa os servidores de desenvolvimento dos projetos principais, excluindo a maioria dos exemplos. Na primeira execução, requer que os pacotes estejam compilados e o codegen tenha sido executado. Depois disso, monitorará alterações nos arquivos (incluindo os de geração de código). Se você precisar reiniciar o servidor de desenvolvimento por qualquer motivo, isso é um bug que você pode reportar. +pnpm dev:full: Executa os servidores de desenvolvimento para todos os projetos, incluindo exemplos. +pnpm dev:basic: Executa os servidores de desenvolvimento apenas para os serviços necessários (backend e dashboard). Não recomendado para a maioria dos usuários, prefira fazer upgrade na sua máquina. + +# Comandos de ambiente +pnpm start-deps: Inicia as dependências Docker (DB, Inbucket, etc.) como containers Docker e as inicializa com o script de seed e migrações. Nota: as dependências iniciadas serão visíveis no launchpad de desenvolvimento (porta 8100 por padrão). +pnpm stop-deps: Para as dependências Docker (DB, Inbucket, etc.) e exclui os dados associados. +pnpm restart-deps: Para e reinicia as dependências. + +# Comandos de banco de dados +pnpm db:migration-gen: Atualmente não utilizado. Gere migrações do Prisma manualmente (ou com IA). +pnpm db:reset: Reseta o banco de dados para o estado inicial. Executado automaticamente por `pnpm start-deps`. +pnpm db:init: Inicializa o banco de dados com o script de seed e migrações. Executado automaticamente por `pnpm db:reset`. +pnpm db:seed: Re-executa o seed do banco de dados com o script de seed. Executado automaticamente por `pnpm db:init`. +pnpm db:migrate: Executa as migrações. Executado automaticamente por `pnpm db:init`. + +# Comandos de teste +pnpm test : Executa os testes. Passe `--bail 1` para executar os testes apenas até a primeira falha. Passe `--no-watch` para executar os testes uma única vez em vez de em modo watch. + +# Comandos diversos +pnpm explain-query: Cole uma consulta SQL para obter uma explicação do plano de consulta, ajudando a depurar problemas de desempenho. +pnpm verify-data-integrity: Verifica a integridade dos dados no banco de dados executando uma série de verificações. Isso nunca deve falhar em nenhum momento (a menos que você tenha modificado o DB manualmente). +``` + +Nota: ao trabalhar com IA, você deve manter uma aba do terminal com o servidor de desenvolvimento aberta para que a IA possa executar consultas nele. + +## ❤ Contribuidores + + + + diff --git a/README.zh-CN.md b/README.zh-CN.md new file mode 100644 index 0000000000..8a8283f200 --- /dev/null +++ b/README.zh-CN.md @@ -0,0 +1,183 @@ +> 此翻译由 Claude 生成。如有改进建议，欢迎提交 PR。 + +[![Stack Logo](/.github/assets/logo.png)](https://stack-auth.com) + +

+ 📘 文档 + | ☁️ 托管版本 + | ✨ 演示 + | 🎮 Discord +

+ +

+ English | 繁體中文 | 简体中文 | 日本語 | 한국어 | Deutsch | Español | Français | Italiano | Português (Brasil) +

+ +# Stack Auth：开源身份验证平台 + +Stack Auth 是一套托管式用户身份验证解决方案。它对开发者友好，且完全开源（采用 MIT 和 AGPL 许可证）。 + +Stack Auth 让你在短短五分钟内即可上手，之后随着项目成长，你可以使用它的所有功能。我们的托管服务完全是可选的，你可以随时导出用户数据并免费自行托管。 + +我们支持 Next.js、React 和 JavaScript 前端，以及任何可以使用我们 [REST API](https://docs.stack-auth.com/api/overview) 的后端。查看我们的[设置指南](https://docs.stack-auth.com/docs/next/getting-started/setup)以开始使用。 + +
+Stack Auth Setup +
+ +## 与 X 有什么不同？ + +问问自己关于 `X`： + +- `X` 是开源的吗？ +- `X` 对开发者友好吗？文档完善吗？能在几分钟内上手吗？ +- 除了身份验证，`X` 还提供授权和用户管理吗（见下方功能列表）？ + +如果以上任何一个问题你的回答是"否"，那就是 Stack Auth 与 `X` 的不同之处。 + +## ✨ 功能 + +想第一时间收到新功能通知，请订阅[我们的新闻通讯](https://stack-auth.beehiiv.com/subscribe)。 + +| | | +|-|:-:| +|

`` 和 ``

支持 OAuth、密码凭证和魔法链接的身份验证组件，具有共享开发密钥以加速设置。所有组件均支持深色/浅色模式。 | Sign-in component | +|

惯用的 Next.js API

我们基于服务器组件、React hooks 和路由处理器构建。 | ![Dark/light mode](.github/assets/components.png) | +|

用户仪表板

用于筛选、分析和编辑用户的仪表板。替代你原本需要构建的第一个内部工具。 | ![User dashboard](.github/assets/dashboard.png) | +|

账户设置

让用户更新个人资料、验证电子邮件或更改密码。无需额外设置。 | Account settings component | +|

多租户与团队

通过合理且可扩展至数百万的组织架构来管理 B2B 客户。 | Selected team switcher component | +|

基于角色的访问控制

定义任意的权限图并分配给用户。组织可以创建组织专属的角色。 | RBAC | +|

OAuth 连接

除了登录之外，Stack Auth 还可以管理第三方 API 的访问令牌，例如 Outlook 和 Google Calendar。它会处理令牌刷新和范围控制，让访问令牌仅需一个函数调用即可获取。 | OAuth tokens | +|

Passkeys

支持使用 Passkeys 的无密码身份验证，让用户可以在所有设备上通过生物识别或安全密钥安全登录。 | OAuth tokens | +|

用户模拟

模拟用户进行调试和支持，以他们的身份登录账户。 | Webhooks | +|

Webhooks

当用户使用你的产品时获得通知，基于 Svix 构建。 | Webhooks | +|

自动化邮件

在注册、密码重置和电子邮件验证等触发事件时发送可自定义的邮件，可通过所见即所得编辑器编辑。 | Email templates | +|

用户会话与 JWT 处理

Stack Auth 管理刷新令牌和访问令牌、JWT 和 Cookie，以零实现成本实现最佳性能。 | User button | +|

M2M 身份验证

使用短期访问令牌来验证机器对机器的通信。 | M2M authentication | + + +## 📦 安装与设置 + +在你的 Next.js 项目中安装 Stack Auth（如需 React、JavaScript 或其他框架，请参阅我们的[完整文档](https://docs.stack-auth.com)）： + +1. 使用以下命令运行 Stack Auth 的安装向导： + ```bash + npx @stackframe/stack-cli@latest init + ``` + +2. 然后在 [Stack Auth 仪表板](https://app.stack-auth.com/projects)上创建账户，创建一个带有 API 密钥的新项目，并将其环境变量复制到你 Next.js 项目的 .env.local 文件中： + ``` + NEXT_PUBLIC_STACK_PROJECT_ID= + NEXT_PUBLIC_STACK_PUBLISHABLE_CLIENT_KEY= + STACK_SECRET_SERVER_KEY= + ``` +3. 完成了！你可以使用 `npm run dev` 运行你的应用程序，并前往 [http://localhost:3000/handler/signup](http://localhost:3000/handler/signup) 查看注册页面。你也可以在 [http://localhost:3000/handler/account-settings](http://localhost:3000/handler/account-settings) 查看账户设置页面。 + +查看[文档](https://docs.stack-auth.com/getting-started/setup)以获取更详细的指南。 + +## 🌱 一些使用 Stack Auth 构建的社区项目 + +有自己的项目吗？欢迎创建 PR 或在 [Discord](https://discord.stack-auth.com) 上联系我们，我们很乐意展示它。 + +### Templates +- [Stack Auth Template by Stack Auth Team](https://github.com/stack-auth/stack-auth-template) +- [Next SaaSkit by wolfgunblood](https://github.com/wolfgunblood/nextjs-saaskit) +- [SaaS Boilerplate by Robin Faraj](https://github.com/robinfaraj/saas-boilerplate) + +### Examples +- [Stack Auth Example by career-tokens](https://github.com/career-tokens/StackYCAuth) +- [Stack Auth Demo by the Stack Auth team](https://github.com/stack-auth/stack-auth/tree/dev/examples/demo) +- [Stack Auth E-Commerce Example by the Stack Auth team](https://github.com/stack-auth/stack-auth/tree/dev/examples/e-commerce) + +## 🏗 开发与贡献 + +如果你想为 Stack Auth 项目做出贡献或在本地运行 Stack Auth 仪表板，本节适合你。 + +**重要**：请仔细阅读[贡献指南](CONTRIBUTING.md)，并加入[我们的 Discord](https://discord.stack-auth.com) 如果你想提供帮助。 + +### 系统要求 + +- Node v20 +- pnpm v9 +- Docker + +### 设置 + +注意：建议使用 24GB 以上的内存以获得流畅的开发体验。 + +在新的终端中： + +```sh +pnpm install + +# 构建包并生成代码。这只需要做一次，之后 `pnpm dev` 会自动处理 +pnpm build:packages +pnpm codegen + +# 以 Docker 容器启动依赖服务（数据库、Inbucket 等），并使用 Prisma schema 初始化数据库 +# 请确保已安装并运行 Docker（或 OrbStack） +pnpm restart-deps + +# 启动开发服务器 +pnpm dev + +# 在另一个终端中，以监听模式运行测试 +pnpm test # 实用参数：--no-watch（禁用监听模式）和 --bail 1（在第一个失败后停止） +``` + +现在你可以在 [http://localhost:8100](http://localhost:8100) 打开开发启动台。从那里你可以导航到 [http://localhost:8101](http://localhost:8101) 的仪表板、8102 端口的 API、8103 端口的演示、8104 端口的文档、8105 端口的 Inbucket（电子邮件）和 8106 端口的 Prisma Studio。详细的运行服务列表请参阅开发启动台。 + +你的 IDE 可能会在所有 `@stackframe/XYZ` 导入上显示错误。要修复此问题，只需重新启动 TypeScript 语言服务器；例如在 VSCode 中你可以打开命令面板（Ctrl+Shift+P）并运行 `Developer: Reload Window` 或 `TypeScript: Restart TS server`。 + +以下设置的预填充 .env 文件已准备好，并默认在每个包的 `.env.development` 中使用。但是如果你要创建生产版本（例如使用 `pnpm run build`），你必须手动提供环境变量（见下方）。 + +### 常用命令 + +```sh +# 注意： +# 请参阅开发启动台（默认：http://localhost:8100）以获取所有运行服务的列表。 + +# 安装命令 +pnpm install: 安装依赖包 + +# 类型与代码检查命令 +pnpm typecheck: 运行 TypeScript 类型检查。可能需要先构建或启动开发服务器。 +pnpm lint: 运行 ESLint 代码检查。可选择传入 `--fix` 以修复部分检查错误。可能需要先构建或启动开发服务器。 + +# 构建命令 +pnpm build: 构建所有项目，包括应用程序、包、示例和文档。同时运行代码生成任务。在运行之前，你需要将所有文件夹中的 `.env.development` 文件复制为 `.env.production.local` 或手动设置环境变量。 +pnpm build:packages: 构建所有 npm 包。 +pnpm codegen: 运行所有代码生成任务，例如 Prisma client 和 OpenAPI 文档生成。 + +# 开发命令 +pnpm dev: 运行主要项目的开发服务器，不包括大部分示例。首次运行时需要先构建包并运行 codegen。之后它会监听文件变更（包括代码生成文件）。如果你因任何原因需要重新启动开发服务器，那是一个可以报告的错误。 +pnpm dev:full: 运行所有项目的开发服务器，包括示例。 +pnpm dev:basic: 仅运行必要服务（后端和仪表板）的开发服务器。不建议大多数用户使用，请升级你的设备。 + +# 环境命令 +pnpm start-deps: 以 Docker 容器启动依赖服务（数据库、Inbucket 等），并使用种子脚本和迁移进行初始化。注意：启动的依赖服务会显示在开发启动台上（默认为 8100 端口）。 +pnpm stop-deps: 停止 Docker 依赖服务（数据库、Inbucket 等）并删除其中的数据。 +pnpm restart-deps: 停止并重新启动依赖服务。 + +# 数据库命令 +pnpm db:migration-gen: 目前未使用。请手动（或使用 AI）生成 Prisma 迁移。 +pnpm db:reset: 将数据库重置为初始状态。由 `pnpm start-deps` 自动运行。 +pnpm db:init: 使用种子脚本和迁移初始化数据库。由 `pnpm db:reset` 自动运行。 +pnpm db:seed: 使用种子脚本重新填充数据库。由 `pnpm db:init` 自动运行。 +pnpm db:migrate: 运行迁移。由 `pnpm db:init` 自动运行。 + +# 测试命令 +pnpm test : 运行测试。传入 `--bail 1` 使测试在第一个失败后停止。传入 `--no-watch` 运行一次测试而非监听模式。 + +# 其他命令 +pnpm explain-query: 粘贴 SQL 查询以获取查询计划的说明，帮助你调试性能问题。 +pnpm verify-data-integrity: 通过运行一系列完整性检查来验证数据库中的数据完整性。这在任何时间点都不应该失败（除非你手动修改了数据库）。 +``` + +注意：使用 AI 工作时，你应该保持一个打开开发服务器的终端标签页，让 AI 可以对其运行查询。 + +## ❤ 贡献者 + + + + diff --git a/README.zh-TW.md b/README.zh-TW.md new file mode 100644 index 0000000000..b90feb05d9 --- /dev/null +++ b/README.zh-TW.md @@ -0,0 +1,183 @@ +> 此翻譯由 Claude 生成。如有改進建議，歡迎提交 PR。 + +[![Stack Logo](/.github/assets/logo.png)](https://stack-auth.com) + +

+ 📘 文件 + | ☁️ 託管版本 + | ✨ 示範 + | 🎮 Discord +

+ +

+ English | 繁體中文 | 简体中文 | 日本語 | 한국어 | Deutsch | Español | Français | Italiano | Português (Brasil) +

+ +# Stack Auth：開源身份驗證平台 + +Stack Auth 是一套託管式使用者身份驗證解決方案。它對開發者友善，且完全開源（採用 MIT 和 AGPL 授權）。 + +Stack Auth 讓你在短短五分鐘內即可上手，之後隨著專案成長，你可以使用它的所有功能。我們的託管服務完全是可選的，你可以隨時匯出使用者資料並免費自行託管。 + +我們支援 Next.js、React 和 JavaScript 前端，以及任何可以使用我們 [REST API](https://docs.stack-auth.com/api/overview) 的後端。查看我們的[設定指南](https://docs.stack-auth.com/docs/next/getting-started/setup)以開始使用。 + +
+Stack Auth Setup +
+ +## 與 X 有什麼不同？ + +問問自己關於 `X`： + +- `X` 是開源的嗎？ +- `X` 對開發者友善嗎？文件完善嗎？能在幾分鐘內上手嗎？ +- 除了身份驗證，`X` 還提供授權和使用者管理嗎（見下方功能列表）？ + +如果以上任何一個問題你的回答是「否」，那就是 Stack Auth 與 `X` 的不同之處。 + +## ✨ 功能 + +想第一時間收到新功能通知，請訂閱[我們的電子報](https://stack-auth.beehiiv.com/subscribe)。 + +| | | +|-|:-:| +|

`` 和 ``

支援 OAuth、密碼憑證和魔法連結的身份驗證元件，具有共享開發金鑰以加速設定。所有元件均支援深色/淺色模式。 | Sign-in component | +|

慣用的 Next.js API

我們基於伺服器元件、React hooks 和路由處理器構建。 | ![Dark/light mode](.github/assets/components.png) | +|

使用者儀表板

用於篩選、分析和編輯使用者的儀表板。取代你原本需要建立的第一個內部工具。 | ![User dashboard](.github/assets/dashboard.png) | +|

帳戶設定

讓使用者更新個人資料、驗證電子郵件或變更密碼。無需額外設定。 | Account settings component | +|

多租戶與團隊

透過合理且可擴展至數百萬的組織架構來管理 B2B 客戶。 | Selected team switcher component | +|

基於角色的存取控制

定義任意的權限圖表並指派給使用者。組織可以建立組織專屬的角色。 | RBAC | +|

OAuth 連線

除了登入之外，Stack Auth 還可以管理第三方 API 的存取權杖，例如 Outlook 和 Google Calendar。它會處理權杖刷新和範圍控制，讓存取權杖僅需一個函式呼叫即可取得。 | OAuth tokens | +|

Passkeys

支援使用 Passkeys 的無密碼身份驗證，讓使用者可以在所有裝置上透過生物辨識或安全金鑰安全登入。 | OAuth tokens | +|

使用者模擬

模擬使用者進行除錯和支援，以他們的身份登入帳戶。 | Webhooks | +|

Webhooks

當使用者使用你的產品時獲得通知，基於 Svix 構建。 | Webhooks | +|

自動化郵件

在註冊、密碼重設和電子郵件驗證等觸發事件時發送可自訂的郵件，可透過所見即所得編輯器編輯。 | Email templates | +|

使用者工作階段與 JWT 處理

Stack Auth 管理刷新權杖和存取權杖、JWT 和 Cookie，以零實作成本實現最佳效能。 | User button | +|

M2M 身份驗證

使用短期存取權杖來驗證機器對機器的通訊。 | M2M authentication | + + +## 📦 安裝與設定 + +在你的 Next.js 專案中安裝 Stack Auth（如需 React、JavaScript 或其他框架，請參閱我們的[完整文件](https://docs.stack-auth.com)）： + +1. 使用以下指令執行 Stack Auth 的安裝精靈： + ```bash + npx @stackframe/stack-cli@latest init + ``` + +2. 然後在 [Stack Auth 儀表板](https://app.stack-auth.com/projects)上建立帳戶，建立一個帶有 API 金鑰的新專案，並將其環境變數複製到你 Next.js 專案的 .env.local 檔案中： + ``` + NEXT_PUBLIC_STACK_PROJECT_ID= + NEXT_PUBLIC_STACK_PUBLISHABLE_CLIENT_KEY= + STACK_SECRET_SERVER_KEY= + ``` +3. 完成了！你可以使用 `npm run dev` 執行你的應用程式，並前往 [http://localhost:3000/handler/signup](http://localhost:3000/handler/signup) 查看註冊頁面。你也可以在 [http://localhost:3000/handler/account-settings](http://localhost:3000/handler/account-settings) 查看帳戶設定頁面。 + +查看[文件](https://docs.stack-auth.com/getting-started/setup)以獲取更詳細的指南。 + +## 🌱 一些使用 Stack Auth 建立的社群專案 + +有自己的專案嗎？歡迎建立 PR 或在 [Discord](https://discord.stack-auth.com) 上聯繫我們，我們很樂意展示它。 + +### Templates +- [Stack Auth Template by Stack Auth Team](https://github.com/stack-auth/stack-auth-template) +- [Next SaaSkit by wolfgunblood](https://github.com/wolfgunblood/nextjs-saaskit) +- [SaaS Boilerplate by Robin Faraj](https://github.com/robinfaraj/saas-boilerplate) + +### Examples +- [Stack Auth Example by career-tokens](https://github.com/career-tokens/StackYCAuth) +- [Stack Auth Demo by the Stack Auth team](https://github.com/stack-auth/stack-auth/tree/dev/examples/demo) +- [Stack Auth E-Commerce Example by the Stack Auth team](https://github.com/stack-auth/stack-auth/tree/dev/examples/e-commerce) + +## 🏗 開發與貢獻 + +如果你想為 Stack Auth 專案做出貢獻或在本地執行 Stack Auth 儀表板，本節適合你。 + +**重要**：請仔細閱讀[貢獻指南](CONTRIBUTING.md)，並加入[我們的 Discord](https://discord.stack-auth.com)如果你想提供幫助。 + +### 系統需求 + +- Node v20 +- pnpm v9 +- Docker + +### 設定 + +注意：建議使用 24GB 以上的記憶體以獲得流暢的開發體驗。 + +在新的終端機中： + +```sh +pnpm install + +# 建置套件並產生程式碼。這只需要做一次，之後 `pnpm dev` 會自動處理 +pnpm build:packages +pnpm codegen + +# 以 Docker 容器啟動相依服務（資料庫、Inbucket 等），並使用 Prisma schema 初始化資料庫 +# 請確保已安裝並執行 Docker（或 OrbStack） +pnpm restart-deps + +# 啟動開發伺服器 +pnpm dev + +# 在另一個終端機中，以監看模式執行測試 +pnpm test # 實用參數：--no-watch（停用監看模式）和 --bail 1（在第一個失敗後停止） +``` + +現在你可以在 [http://localhost:8100](http://localhost:8100) 開啟開發啟動台。從那裡你可以導航到 [http://localhost:8101](http://localhost:8101) 的儀表板、8102 埠的 API、8103 埠的示範、8104 埠的文件、8105 埠的 Inbucket（電子郵件）和 8106 埠的 Prisma Studio。詳細的執行服務列表請參閱開發啟動台。 + +你的 IDE 可能會在所有 `@stackframe/XYZ` 匯入上顯示錯誤。要修正此問題，只需重新啟動 TypeScript 語言伺服器；例如在 VSCode 中你可以開啟命令面板（Ctrl+Shift+P）並執行 `Developer: Reload Window` 或 `TypeScript: Restart TS server`。 + +以下設定的預設 .env 檔案已準備好，並預設在每個套件的 `.env.development` 中使用。但是如果你要建立正式版本（例如使用 `pnpm run build`），你必須手動提供環境變數（見下方）。 + +### 常用指令 + +```sh +# 注意： +# 請參閱開發啟動台（預設：http://localhost:8100）以獲取所有執行服務的列表。 + +# 安裝指令 +pnpm install: 安裝相依套件 + +# 型別與程式碼檢查指令 +pnpm typecheck: 執行 TypeScript 型別檢查。可能需要先建置或啟動開發伺服器。 +pnpm lint: 執行 ESLint 程式碼檢查。可選擇傳入 `--fix` 以修正部分檢查錯誤。可能需要先建置或啟動開發伺服器。 + +# 建置指令 +pnpm build: 建置所有專案，包括應用程式、套件、範例和文件。同時執行程式碼產生任務。在執行之前，你需要將所有資料夾中的 `.env.development` 檔案複製為 `.env.production.local` 或手動設定環境變數。 +pnpm build:packages: 建置所有 npm 套件。 +pnpm codegen: 執行所有程式碼產生任務，例如 Prisma client 和 OpenAPI 文件產生。 + +# 開發指令 +pnpm dev: 執行主要專案的開發伺服器，不包括大部分範例。首次執行時需要先建置套件並執行 codegen。之後它會監看檔案變更（包括程式碼產生檔案）。如果你因任何原因需要重新啟動開發伺服器，那是一個可以回報的錯誤。 +pnpm dev:full: 執行所有專案的開發伺服器，包括範例。 +pnpm dev:basic: 僅執行必要服務（後端和儀表板）的開發伺服器。不建議大多數使用者使用，請升級你的設備。 + +# 環境指令 +pnpm start-deps: 以 Docker 容器啟動相依服務（資料庫、Inbucket 等），並使用種子腳本和遷移進行初始化。注意：啟動的相依服務會顯示在開發啟動台上（預設為 8100 埠）。 +pnpm stop-deps: 停止 Docker 相依服務（資料庫、Inbucket 等）並刪除其中的資料。 +pnpm restart-deps: 停止並重新啟動相依服務。 + +# 資料庫指令 +pnpm db:migration-gen: 目前未使用。請手動（或使用 AI）產生 Prisma 遷移。 +pnpm db:reset: 將資料庫重設為初始狀態。由 `pnpm start-deps` 自動執行。 +pnpm db:init: 使用種子腳本和遷移初始化資料庫。由 `pnpm db:reset` 自動執行。 +pnpm db:seed: 使用種子腳本重新填充資料庫。由 `pnpm db:init` 自動執行。 +pnpm db:migrate: 執行遷移。由 `pnpm db:init` 自動執行。 + +# 測試指令 +pnpm test : 執行測試。傳入 `--bail 1` 使測試在第一個失敗後停止。傳入 `--no-watch` 執行一次測試而非監看模式。 + +# 其他指令 +pnpm explain-query: 貼上 SQL 查詢以獲取查詢計畫的說明，幫助你除錯效能問題。 +pnpm verify-data-integrity: 透過執行一系列完整性檢查來驗證資料庫中的資料完整性。這在任何時間點都不應該失敗（除非你手動修改了資料庫）。 +``` + +注意：使用 AI 工作時，你應該保持一個開啟開發伺服器的終端機分頁，讓 AI 可以對其執行查詢。 + +## ❤ 貢獻者 + + + + From 02be46c77737a3f827821101f7a91fc985a1460f Mon Sep 17 00:00:00 2001 From: Lawrence Chen Date: Tue, 24 Mar 2026 21:11:31 -0700 Subject: [PATCH 2/2] Add 10 more language translations (19 total) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit New languages: العربية, Bosanski, Dansk, Norsk, Polski, Русский, ไทย, Tiếng Việt, Türkçe, ភាសាខ្មែរ. Updated language selector in all existing files to include all 19 translations. --- README.ar.md | 158 ++++++++++++++++++++++++++++++++++++++++++++++++ README.bs.md | 158 ++++++++++++++++++++++++++++++++++++++++++++++++ README.da.md | 158 ++++++++++++++++++++++++++++++++++++++++++++++++ README.de.md | 2 +- README.es.md | 2 +- README.fr.md | 2 +- README.it.md | 2 +- README.ja.md | 2 +- README.km.md | 158 ++++++++++++++++++++++++++++++++++++++++++++++++ README.ko.md | 2 +- README.md | 2 +- README.no.md | 158 ++++++++++++++++++++++++++++++++++++++++++++++++ README.pl.md | 158 ++++++++++++++++++++++++++++++++++++++++++++++++ README.pt-BR.md | 2 +- README.ru.md | 158 ++++++++++++++++++++++++++++++++++++++++++++++++ README.th.md | 158 ++++++++++++++++++++++++++++++++++++++++++++++++ README.tr.md | 158 ++++++++++++++++++++++++++++++++++++++++++++++++ README.vi.md | 158 ++++++++++++++++++++++++++++++++++++++++++++++++ README.zh-CN.md | 2 +- README.zh-TW.md | 2 +- 20 files changed, 1590 insertions(+), 10 deletions(-) create mode 100644 README.ar.md create mode 100644 README.bs.md create mode 100644 README.da.md create mode 100644 README.km.md create mode 100644 README.no.md create mode 100644 README.pl.md create mode 100644 README.ru.md create mode 100644 README.th.md create mode 100644 README.tr.md create mode 100644 README.vi.md diff --git a/README.ar.md b/README.ar.md new file mode 100644 index 0000000000..6d0e10ddbf --- /dev/null +++ b/README.ar.md @@ -0,0 +1,158 @@ +> تمت ترجمة هذا المستند بواسطة Claude. إذا كانت لديك اقتراحات للتحسين، فإن طلبات السحب مرحب بها. + +[![Stack Logo](/.github/assets/logo.png)](https://stack-auth.com) + +

+ 📘 التوثيق + | ☁️ النسخة السحابية + | ✨ عرض تجريبي + | 🎮 Discord +

+ +

+ English | 繁體中文 | 简体中文 | 日本語 | 한국어 | العربية | Bosanski | Dansk | Deutsch | Español | Français | Italiano | Norsk | Polski | Português (Brasil) | Русский | ไทย | Tiếng Việt | Türkçe | ភាសាខ្មែរ +

+ +# Stack Auth: منصة المصادقة مفتوحة المصدر + +Stack Auth هو حل مُدار لمصادقة المستخدمين. إنه سهل الاستخدام للمطورين ومفتوح المصدر بالكامل (مرخص بموجب MIT وAGPL). + +يتيح لك Stack Auth البدء في خمس دقائق فقط، وبعدها ستكون جاهزاً لاستخدام جميع ميزاته مع نمو مشروعك. خدمتنا المُدارة اختيارية تماماً ويمكنك تصدير بيانات المستخدمين واستضافة النظام بنفسك، مجاناً، في أي وقت. + +نحن ندعم واجهات Next.js وReact وJavaScript الأمامية، بالإضافة إلى أي واجهة خلفية يمكنها استخدام [REST API](https://docs.stack-auth.com/api/overview) الخاص بنا. اطلع على [دليل الإعداد](https://docs.stack-auth.com/docs/next/getting-started/setup) للبدء. + +
+Stack Auth Setup +
+ +## كيف يختلف هذا عن X؟ + +اسأل نفسك عن `X`: + +- هل `X` مفتوح المصدر؟ +- هل `X` سهل الاستخدام للمطورين، وموثق جيداً، ويتيح لك البدء في دقائق؟ +- إلى جانب المصادقة، هل يوفر `X` أيضاً التفويض وإدارة المستخدمين (انظر قائمة الميزات أدناه)؟ + +إذا أجبت بـ "لا" على أي من هذه الأسئلة، فهذا هو ما يميز Stack Auth عن `X`. + +## ✨ الميزات + +للحصول على إشعارات أولاً عند إضافة ميزات جديدة، يرجى الاشتراك في [نشرتنا الإخبارية](https://stack-auth.beehiiv.com/subscribe). + +| | | +|-|:-:| +|

`` و ``

مكونات المصادقة التي تدعم OAuth، وبيانات اعتماد كلمة المرور، والروابط السحرية، مع مفاتيح تطوير مشتركة لتسريع الإعداد. جميع المكونات تدعم الوضع الداكن والفاتح. | Sign-in component | +|

واجهات برمجة Next.js الاصطلاحية

نبني على مكونات الخادم، وخطافات React، ومعالجات المسارات. | ![Dark/light mode](.github/assets/components.png) | +|

لوحة تحكم المستخدمين

لوحة تحكم لتصفية المستخدمين وتحليلهم وتعديلهم. تحل محل أول أداة داخلية كنت ستحتاج لبنائها. | ![User dashboard](.github/assets/dashboard.png) | +|

إعدادات الحساب

تتيح للمستخدمين تحديث ملفهم الشخصي، أو التحقق من بريدهم الإلكتروني، أو تغيير كلمة المرور. لا يلزم أي إعداد. | Account settings component | +|

تعدد المستأجرين والفرق

إدارة عملاء B2B بهيكل تنظيمي منطقي وقابل للتوسع إلى الملايين. | Selected team switcher component | +|

التحكم في الوصول المبني على الأدوار

حدد مخطط أذونات عشوائي وعيّنه للمستخدمين. يمكن للمؤسسات إنشاء أدوار خاصة بالمؤسسة. | RBAC | +|

اتصالات OAuth

بالإضافة إلى تسجيل الدخول، يمكن لـ Stack Auth أيضاً إدارة رموز الوصول لواجهات برمجة التطبيقات الخارجية، مثل Outlook وGoogle Calendar. يتولى تجديد الرموز والتحكم في النطاق، مما يجعل رموز الوصول متاحة عبر استدعاء دالة واحد. | OAuth tokens | +|

Passkeys

دعم المصادقة بدون كلمة مرور باستخدام passkeys، مما يتيح للمستخدمين تسجيل الدخول بأمان باستخدام القياسات الحيوية أو مفاتيح الأمان عبر جميع أجهزتهم. | OAuth tokens | +|

انتحال الهوية

انتحل هوية المستخدمين لأغراض تصحيح الأخطاء والدعم، بتسجيل الدخول إلى حسابهم كما لو كنت أنت هم. | Webhooks | +|

Webhooks

احصل على إشعارات عندما يستخدم المستخدمون منتجك، مبني على Svix. | Webhooks | +|

رسائل البريد الإلكتروني التلقائية

أرسل رسائل بريد إلكتروني قابلة للتخصيص عند مشغلات مثل التسجيل، وإعادة تعيين كلمة المرور، والتحقق من البريد الإلكتروني، قابلة للتحرير باستخدام محرر WYSIWYG. | Email templates | +|

إدارة جلسات المستخدم وJWT

يدير Stack Auth رموز التجديد والوصول، وJWT، والكوكيز، مما يؤدي إلى أفضل أداء دون تكلفة تنفيذ. | User button | +|

مصادقة الآلة إلى الآلة (M2M)

استخدم رموز وصول قصيرة الأجل لمصادقة أجهزتك مع أجهزة أخرى. | M2M authentication | + + +## 📦 التثبيت والإعداد + +لتثبيت Stack Auth في مشروع Next.js الخاص بك (لـ React أو JavaScript أو أطر العمل الأخرى، انظر [التوثيق الكامل](https://docs.stack-auth.com)): + +1. قم بتشغيل معالج تثبيت Stack Auth بالأمر التالي: + ```bash + npx @stackframe/stack-cli@latest init + ``` + +2. ثم أنشئ حساباً على [لوحة تحكم Stack Auth](https://app.stack-auth.com/projects)، وأنشئ مشروعاً جديداً بمفتاح API، وانسخ متغيرات البيئة الخاصة به إلى ملف .env.local في مشروع Next.js الخاص بك: + ``` + NEXT_PUBLIC_STACK_PROJECT_ID= + NEXT_PUBLIC_STACK_PUBLISHABLE_CLIENT_KEY= + STACK_SECRET_SERVER_KEY= + ``` +3. هذا كل شيء! يمكنك تشغيل تطبيقك بأمر `npm run dev` والذهاب إلى [http://localhost:3000/handler/signup](http://localhost:3000/handler/signup) لرؤية صفحة التسجيل. يمكنك أيضاً الاطلاع على صفحة إعدادات الحساب على [http://localhost:3000/handler/account-settings](http://localhost:3000/handler/account-settings). + +اطلع على [التوثيق](https://docs.stack-auth.com/getting-started/setup) للحصول على دليل أكثر تفصيلاً. + +## 🌱 بعض مشاريع المجتمع المبنية باستخدام Stack Auth + +لديك مشروع خاص بك؟ يسعدنا عرضه إذا أنشأت طلب سحب أو راسلتنا على [Discord](https://discord.stack-auth.com). + +### Templates +- [Stack Auth Template by Stack Auth Team](https://github.com/stack-auth/stack-auth-template) +- [Next SaaSkit by wolfgunblood](https://github.com/wolfgunblood/nextjs-saaskit) +- [SaaS Boilerplate by Robin Faraj](https://github.com/robinfaraj/saas-boilerplate) + +### Examples +- [Stack Auth Example by career-tokens](https://github.com/career-tokens/StackYCAuth) +- [Stack Auth Demo by the Stack Auth team](https://github.com/stack-auth/stack-auth/tree/dev/examples/demo) +- [Stack Auth E-Commerce Example by the Stack Auth team](https://github.com/stack-auth/stack-auth/tree/dev/examples/e-commerce) + +## 🏗 التطوير والمساهمة + +هذا القسم لك إذا كنت ترغب في المساهمة في مشروع Stack Auth أو تشغيل لوحة تحكم Stack Auth محلياً. + +**مهم**: يرجى قراءة [إرشادات المساهمة](CONTRIBUTING.md) بعناية والانضمام إلى [Discord الخاص بنا](https://discord.stack-auth.com) إذا كنت ترغب في المساعدة. + +### المتطلبات + +- Node v20 +- pnpm v9 +- Docker + +### الإعداد + +ملاحظة: يُوصى بذاكرة وصول عشوائي بحجم 24 جيجابايت أو أكثر لتجربة تطوير سلسة. + +في نافذة طرفية جديدة: + +```sh +pnpm install +pnpm build:packages +pnpm codegen +pnpm restart-deps +pnpm dev + +# في نافذة طرفية أخرى، قم بتشغيل الاختبارات في وضع المراقبة +pnpm test +``` + +يمكنك الآن فتح صفحة التطوير على [http://localhost:8100](http://localhost:8100). من هناك، يمكنك الانتقال إلى لوحة التحكم على [http://localhost:8101](http://localhost:8101)، وAPI على المنفذ 8102، والعرض التجريبي على المنفذ 8103، والتوثيق على المنفذ 8104، وInbucket (البريد الإلكتروني) على المنفذ 8105، وPrisma Studio على المنفذ 8106. انظر صفحة التطوير لقائمة جميع الخدمات قيد التشغيل. + +قد يعرض محرر الأكواد الخاص بك خطأ على جميع استيرادات `@stackframe/XYZ`. لإصلاح ذلك، ما عليك سوى إعادة تشغيل خادم لغة TypeScript؛ على سبيل المثال، في VSCode يمكنك فتح لوحة الأوامر (Ctrl+Shift+P) وتشغيل `Developer: Reload Window` أو `TypeScript: Restart TS server`. + +ملفات .env المعبأة مسبقاً للإعداد أدناه متوفرة وتُستخدم افتراضياً في `.env.development` في كل حزمة. ومع ذلك، إذا كنت تنشئ بناءً إنتاجياً (مثلاً باستخدام `pnpm run build`)، يجب عليك توفير متغيرات البيئة يدوياً (انظر أدناه). + +### أوامر مفيدة + +```sh +pnpm install +pnpm typecheck +pnpm lint +pnpm build +pnpm build:packages +pnpm codegen +pnpm dev +pnpm dev:full +pnpm dev:basic +pnpm start-deps +pnpm stop-deps +pnpm restart-deps +pnpm db:migration-gen +pnpm db:reset +pnpm db:init +pnpm db:seed +pnpm db:migrate +pnpm test +pnpm explain-query +pnpm verify-data-integrity +``` + +ملاحظة: عند العمل مع الذكاء الاصطناعي، يجب أن تبقي علامة تبويب طرفية مفتوحة مع خادم التطوير حتى يتمكن الذكاء الاصطناعي من تنفيذ الاستعلامات ضده. + +## ❤ المساهمون + + + + diff --git a/README.bs.md b/README.bs.md new file mode 100644 index 0000000000..c8ae167338 --- /dev/null +++ b/README.bs.md @@ -0,0 +1,158 @@ +> Ovaj prijevod je generisan od strane Claude. Ako imate prijedloge za poboljšanje, PR-ovi su dobrodošli. + +[![Stack Logo](/.github/assets/logo.png)](https://stack-auth.com) + +

+ 📘 Dokumentacija + | ☁️ Hostovana verzija + | ✨ Demo + | 🎮 Discord +

+ +

+ English | 繁體中文 | 简体中文 | 日本語 | 한국어 | العربية | Bosanski | Dansk | Deutsch | Español | Français | Italiano | Norsk | Polski | Português (Brasil) | Русский | ไทย | Tiếng Việt | Türkçe | ភាសាខ្មែរ +

+ +# Stack Auth: platforma za autentifikaciju otvorenog koda + +Stack Auth je upravljano rješenje za autentifikaciju korisnika. Prilagođeno je programerima i potpuno je otvorenog koda (licencirano pod MIT i AGPL). + +Stack Auth vam omogućava početak rada za samo pet minuta, nakon čega ćete biti spremni koristiti sve njegove mogućnosti kako vaš projekat raste. Naš upravljani servis je potpuno opcionalan i možete eksportovati podatke korisnika i hostovati ih sami, besplatno, u bilo kojem trenutku. + +Podržavamo Next.js, React i JavaScript frontende, kao i bilo koji backend koji može koristiti naš [REST API](https://docs.stack-auth.com/api/overview). Pogledajte naš [vodič za postavljanje](https://docs.stack-auth.com/docs/next/getting-started/setup) da biste započeli. + +
+Stack Auth Setup +
+ +## Po čemu se ovo razlikuje od X? + +Postavite sebi pitanja o `X`: + +- Da li je `X` otvorenog koda? +- Da li je `X` prilagođen programerima, dobro dokumentovan i omogućava vam da počnete za nekoliko minuta? +- Osim autentifikacije, da li `X` također podržava autorizaciju i upravljanje korisnicima (pogledajte listu funkcija ispod)? + +Ako ste na bilo koje od ovih pitanja odgovorili sa „ne", onda je to način na koji se Stack Auth razlikuje od `X`. + +## ✨ Mogućnosti + +Da biste prvi saznali kada dodamo nove funkcije, pretplatite se na [naš newsletter](https://stack-auth.beehiiv.com/subscribe). + +| | | +|-|:-:| +|

`` i ``

Komponente za autentifikaciju koje podržavaju OAuth, prijavu lozinkom i magične linkove, sa dijeljenim razvojnim ključevima za bržu konfiguraciju. Sve komponente podržavaju tamni i svijetli način rada. | Sign-in component | +|

Idiomatski Next.js API-ji

Gradimo na serverskim komponentama, React hookovima i route handlerima. | ![Dark/light mode](.github/assets/components.png) | +|

Korisnička kontrolna tabla

Kontrolna tabla za filtriranje, analizu i uređivanje korisnika. Zamjenjuje prvi interni alat koji biste morali izgraditi. | ![User dashboard](.github/assets/dashboard.png) | +|

Postavke računa

Omogućava korisnicima ažuriranje profila, verifikaciju e-maila ili promjenu lozinke. Nije potrebna konfiguracija. | Account settings component | +|

Multi-tenancy i timovi

Upravljajte B2B klijentima sa organizacionom strukturom koja ima smisla i skalira se do miliona. | Selected team switcher component | +|

Kontrola pristupa zasnovana na ulogama

Definirajte proizvoljan graf dozvola i dodijelite ga korisnicima. Organizacije mogu kreirati uloge specifične za organizaciju. | RBAC | +|

OAuth konekcije

Osim prijave, Stack Auth također može upravljati pristupnim tokenima za API-je trećih strana, kao što su Outlook i Google Calendar. Upravlja osvježavanjem tokena i kontrolom opsega, čineći pristupne tokene dostupnim putem jednog poziva funkcije. | OAuth tokens | +|

Passkeys

Podrška za autentifikaciju bez lozinke korištenjem passkeys, omogućavajući korisnicima sigurnu prijavu putem biometrije ili sigurnosnih ključeva na svim njihovim uređajima. | OAuth tokens | +|

Impersonacija

Impersonirajte korisnike za debugiranje i podršku, prijavljujući se na njihov račun kao da ste oni. | Webhooks | +|

Webhookovi

Primajte obavijesti kada korisnici koriste vaš proizvod, izgrađeno na Svix-u. | Webhooks | +|

Automatski e-mailovi

Šaljite prilagodljive e-mailove na okidače kao što su registracija, resetovanje lozinke i verifikacija e-maila, uređive pomoću WYSIWYG editora. | Email templates | +|

Upravljanje korisničkim sesijama i JWT

Stack Auth upravlja tokenima za osvježavanje i pristup, JWT-ovima i kolačićima, što rezultira najboljom performansom bez troškova implementacije. | User button | +|

M2M autentifikacija

Koristite kratkotrajne pristupne tokene za autentifikaciju vaših mašina prema drugim mašinama. | M2M authentication | + + +## 📦 Instalacija i postavljanje + +Da biste instalirali Stack Auth u vaš Next.js projekat (za React, JavaScript ili druge frameworke, pogledajte našu [kompletnu dokumentaciju](https://docs.stack-auth.com)): + +1. Pokrenite čarobnjak za instalaciju Stack Auth-a sljedećom komandom: + ```bash + npx @stackframe/stack-cli@latest init + ``` + +2. Zatim kreirajte račun na [Stack Auth kontrolnoj tabli](https://app.stack-auth.com/projects), kreirajte novi projekat sa API ključem i kopirajte njegove varijable okruženja u .env.local fajl vašeg Next.js projekta: + ``` + NEXT_PUBLIC_STACK_PROJECT_ID= + NEXT_PUBLIC_STACK_PUBLISHABLE_CLIENT_KEY= + STACK_SECRET_SERVER_KEY= + ``` +3. To je to! Možete pokrenuti aplikaciju sa `npm run dev` i otići na [http://localhost:3000/handler/signup](http://localhost:3000/handler/signup) da vidite stranicu za registraciju. Također možete pogledati stranicu postavki računa na [http://localhost:3000/handler/account-settings](http://localhost:3000/handler/account-settings). + +Pogledajte [dokumentaciju](https://docs.stack-auth.com/getting-started/setup) za detaljniji vodič. + +## 🌱 Neki projekti zajednice izgrađeni sa Stack Auth-om + +Imate svoj? Rado ćemo ga predstaviti ako kreirate PR ili nam pišete na [Discord](https://discord.stack-auth.com). + +### Templates +- [Stack Auth Template by Stack Auth Team](https://github.com/stack-auth/stack-auth-template) +- [Next SaaSkit by wolfgunblood](https://github.com/wolfgunblood/nextjs-saaskit) +- [SaaS Boilerplate by Robin Faraj](https://github.com/robinfaraj/saas-boilerplate) + +### Examples +- [Stack Auth Example by career-tokens](https://github.com/career-tokens/StackYCAuth) +- [Stack Auth Demo by the Stack Auth team](https://github.com/stack-auth/stack-auth/tree/dev/examples/demo) +- [Stack Auth E-Commerce Example by the Stack Auth team](https://github.com/stack-auth/stack-auth/tree/dev/examples/e-commerce) + +## 🏗 Razvoj i doprinos + +Ovo je za vas ako želite doprinijeti projektu Stack Auth ili pokrenuti Stack Auth kontrolnu tablu lokalno. + +**Važno**: molimo pažljivo pročitajte [smjernice za doprinos](CONTRIBUTING.md) i pridružite se [našem Discord-u](https://discord.stack-auth.com) ako želite pomoći. + +### Zahtjevi + +- Node v20 +- pnpm v9 +- Docker + +### Postavljanje + +Napomena: preporučuje se 24 GB+ RAM-a za ugodno razvojno iskustvo. + +U novom terminalu: + +```sh +pnpm install +pnpm build:packages +pnpm codegen +pnpm restart-deps +pnpm dev + +# U drugom terminalu pokrenite testove u watch modu +pnpm test +``` + +Sada možete otvoriti razvojnu stranicu na [http://localhost:8100](http://localhost:8100). Odatle možete navigirati do kontrolne table na [http://localhost:8101](http://localhost:8101), API-ja na portu 8102, demo-a na portu 8103, dokumentacije na portu 8104, Inbucket-a (e-mailovi) na portu 8105 i Prisma Studio-a na portu 8106. Pogledajte razvojnu stranicu za listu svih pokrenutih servisa. + +Vaš IDE može prikazivati grešku na svim `@stackframe/XYZ` importima. Da biste to popravili, jednostavno restartujte TypeScript jezički server; na primjer, u VSCode-u možete otvoriti paletu komandi (Ctrl+Shift+P) i pokrenuti `Developer: Reload Window` ili `TypeScript: Restart TS server`. + +Prethodno popunjeni .env fajlovi za postavljanje ispod su dostupni i koriste se po defaultu u `.env.development` u svakom od paketa. Međutim, ako kreirate produkcijsku verziju (npr. sa `pnpm run build`), morate ručno navesti varijable okruženja (pogledajte ispod). + +### Korisne komande + +```sh +pnpm install +pnpm typecheck +pnpm lint +pnpm build +pnpm build:packages +pnpm codegen +pnpm dev +pnpm dev:full +pnpm dev:basic +pnpm start-deps +pnpm stop-deps +pnpm restart-deps +pnpm db:migration-gen +pnpm db:reset +pnpm db:init +pnpm db:seed +pnpm db:migrate +pnpm test +pnpm explain-query +pnpm verify-data-integrity +``` + +Napomena: kada radite sa AI-jem, trebali biste držati otvorenu karticu terminala sa dev serverom kako bi AI mogao izvršavati upite prema njemu. + +## ❤ Doprinosioci + + + + diff --git a/README.da.md b/README.da.md new file mode 100644 index 0000000000..52153a43fe --- /dev/null +++ b/README.da.md @@ -0,0 +1,158 @@ +> Denne oversættelse er genereret af Claude. Forslag til forbedringer via PR er velkomne. + +[![Stack Logo](/.github/assets/logo.png)](https://stack-auth.com) + +

+ 📘 Dokumentation + | ☁️ Hostet version + | ✨ Demo + | 🎮 Discord +

+ +

+ English | 繁體中文 | 简体中文 | 日本語 | 한국어 | العربية | Bosanski | Dansk | Deutsch | Español | Français | Italiano | Norsk | Polski | Português (Brasil) | Русский | ไทย | Tiếng Việt | Türkçe | ភាសាខ្មែរ +

+ +# Stack Auth: Den open source-autentificeringsplatform + +Stack Auth er en administreret brugerautentificeringsløsning. Den er udviklervenlig og fuldt open source (licenseret under MIT og AGPL). + +Stack Auth får dig i gang på bare fem minutter, hvorefter du er klar til at bruge alle funktionerne, efterhånden som dit projekt vokser. Vores administrerede tjeneste er helt valgfri, og du kan eksportere dine brugerdata og selv-hoste, gratis, når som helst. + +Vi understøtter Next.js, React og JavaScript-frontends sammen med enhver backend, der kan bruge vores [REST API](https://docs.stack-auth.com/api/overview). Se vores [opsætningsguide](https://docs.stack-auth.com/docs/next/getting-started/setup) for at komme i gang. + +
+Stack Auth Setup +
+ +## Hvordan adskiller dette sig fra X? + +Stil dig selv disse spørgsmål om `X`: + +- Er `X` open source? +- Er `X` udviklervenlig, veldokumenteret, og kan du komme i gang på få minutter? +- Udover autentificering, tilbyder `X` også autorisering og brugeradministration (se funktionslisten nedenfor)? + +Hvis du svarede "nej" til nogen af disse spørgsmål, så er det sådan Stack Auth adskiller sig fra `X`. + +## ✨ Funktioner + +For at blive notificeret først, når vi tilføjer nye funktioner, kan du abonnere på [vores nyhedsbrev](https://stack-auth.beehiiv.com/subscribe). + +| | | +|-|:-:| +|

`` og ``

Autentificeringskomponenter der understøtter OAuth, adgangskodelogin og magic links, med delte udviklingsnøgler for hurtigere opsætning. Alle komponenter understøtter mørk/lys tilstand. | Sign-in component | +|

Idiomatiske Next.js API'er

Vi bygger på server components, React hooks og route handlers. | ![Dark/light mode](.github/assets/components.png) | +|

Bruger-dashboard

Dashboard til at filtrere, analysere og redigere brugere. Erstatter det første interne værktøj, du ellers ville skulle bygge. | ![User dashboard](.github/assets/dashboard.png) | +|

Kontoindstillinger

Lader brugere opdatere deres profil, verificere deres e-mail eller ændre deres adgangskode. Ingen opsætning krævet. | Account settings component | +|

Multi-tenancy & teams

Administrer B2B-kunder med en organisationsstruktur, der giver mening og skalerer til millioner. | Selected team switcher component | +|

Rollebaseret adgangskontrol

Definer en vilkårlig rettighedsgraf og tildel den til brugere. Organisationer kan oprette organisationsspecifikke roller. | RBAC | +|

OAuth-forbindelser

Udover login kan Stack Auth også administrere access tokens til tredjeparts-API'er som Outlook og Google Calendar. Det håndterer fornyelse af tokens og styring af scope, så access tokens er tilgængelige via et enkelt funktionskald. | OAuth tokens | +|

Passkeys

Understøttelse af adgangskodefri autentificering med passkeys, der giver brugere mulighed for at logge ind sikkert med biometri eller sikkerhedsnøgler på tværs af alle deres enheder. | OAuth tokens | +|

Brugerefterligning

Efterlign brugere til fejlfinding og support ved at logge ind på deres konto, som om du var dem. | Webhooks | +|

Webhooks

Bliv notificeret, når brugere anvender dit produkt, bygget på Svix. | Webhooks | +|

Automatiske e-mails

Send tilpassede e-mails ved hændelser som tilmelding, nulstilling af adgangskode og e-mailbekræftelse, redigerbare med en WYSIWYG-editor. | Email templates | +|

Brugersession & JWT-håndtering

Stack Auth administrerer refresh- og access tokens, JWT'er og cookies, hvilket giver den bedste ydeevne uden implementeringsomkostninger. | User button | +|

M2M-autentificering

Brug kortvarige access tokens til at autentificere dine maskiner mod andre maskiner. | M2M authentication | + + +## 📦 Installation & opsætning + +For at installere Stack Auth i dit Next.js-projekt (for React, JavaScript eller andre frameworks, se vores [komplette dokumentation](https://docs.stack-auth.com)): + +1. Kør Stack Auths installationsguide med følgende kommando: + ```bash + npx @stackframe/stack-cli@latest init + ``` + +2. Opret derefter en konto på [Stack Auth-dashboardet](https://app.stack-auth.com/projects), opret et nyt projekt med en API-nøgle, og kopiér miljøvariablerne til .env.local-filen i dit Next.js-projekt: + ``` + NEXT_PUBLIC_STACK_PROJECT_ID= + NEXT_PUBLIC_STACK_PUBLISHABLE_CLIENT_KEY= + STACK_SECRET_SERVER_KEY= + ``` +3. Det var det! Du kan køre din app med `npm run dev` og gå til [http://localhost:3000/handler/signup](http://localhost:3000/handler/signup) for at se tilmeldingssiden. Du kan også se kontoindstillingssiden på [http://localhost:3000/handler/account-settings](http://localhost:3000/handler/account-settings). + +Se [dokumentationen](https://docs.stack-auth.com/getting-started/setup) for en mere detaljeret guide. + +## 🌱 Nogle fællesskabsprojekter bygget med Stack Auth + +Har du dit eget? Vi vil gerne fremhæve det, hvis du opretter en PR eller skriver til os på [Discord](https://discord.stack-auth.com). + +### Templates +- [Stack Auth Template by Stack Auth Team](https://github.com/stack-auth/stack-auth-template) +- [Next SaaSkit by wolfgunblood](https://github.com/wolfgunblood/nextjs-saaskit) +- [SaaS Boilerplate by Robin Faraj](https://github.com/robinfaraj/saas-boilerplate) + +### Examples +- [Stack Auth Example by career-tokens](https://github.com/career-tokens/StackYCAuth) +- [Stack Auth Demo by the Stack Auth team](https://github.com/stack-auth/stack-auth/tree/dev/examples/demo) +- [Stack Auth E-Commerce Example by the Stack Auth team](https://github.com/stack-auth/stack-auth/tree/dev/examples/e-commerce) + +## 🏗 Udvikling & bidrag + +Dette afsnit er for dig, hvis du vil bidrage til Stack Auth-projektet eller køre Stack Auth-dashboardet lokalt. + +**Vigtigt**: Læs venligst [retningslinjerne for bidrag](CONTRIBUTING.md) omhyggeligt og tilslut dig [vores Discord](https://discord.stack-auth.com), hvis du gerne vil hjælpe. + +### Krav + +- Node v20 +- pnpm v9 +- Docker + +### Opsætning + +Bemærk: 24GB+ RAM anbefales for en problemfri udviklingsoplevelse. + +I en ny terminal: + +```sh +pnpm install +pnpm build:packages +pnpm codegen +pnpm restart-deps +pnpm dev + +# I en anden terminal, kør tests i watch-tilstand +pnpm test +``` + +Du kan nu åbne dev-launchpadden på [http://localhost:8100](http://localhost:8100). Derfra kan du navigere til dashboardet på [http://localhost:8101](http://localhost:8101), API på port 8102, demo på port 8103, dokumentation på port 8104, Inbucket (e-mails) på port 8105 og Prisma Studio på port 8106. Se dev-launchpadden for en liste over alle kørende tjenester. + +Din IDE viser muligvis en fejl på alle `@stackframe/XYZ`-imports. For at løse dette skal du blot genstarte TypeScript language server; for eksempel i VSCode kan du åbne kommandopaletten (Ctrl+Shift+P) og køre `Developer: Reload Window` eller `TypeScript: Restart TS server`. + +Forududfyldte .env-filer til opsætningen nedenfor er tilgængelige og bruges som standard i `.env.development` i hver af pakkerne. Hvis du dog opretter en produktionsbuild (f.eks. med `pnpm run build`), skal du levere miljøvariablerne manuelt (se nedenfor). + +### Nyttige kommandoer + +```sh +pnpm install +pnpm typecheck +pnpm lint +pnpm build +pnpm build:packages +pnpm codegen +pnpm dev +pnpm dev:full +pnpm dev:basic +pnpm start-deps +pnpm stop-deps +pnpm restart-deps +pnpm db:migration-gen +pnpm db:reset +pnpm db:init +pnpm db:seed +pnpm db:migrate +pnpm test +pnpm explain-query +pnpm verify-data-integrity +``` + +Bemærk: Når du arbejder med AI, bør du holde en terminalfane åben med dev-serveren, så AI'en kan køre forespørgsler mod den. + +## ❤ Bidragydere + + + + diff --git a/README.de.md b/README.de.md index 564f4554c3..96380658cb 100644 --- a/README.de.md +++ b/README.de.md @@ -10,7 +10,7 @@

- English | 繁體中文 | 简体中文 | 日本語 | 한국어 | Deutsch | Español | Français | Italiano | Português (Brasil) + English | 繁體中文 | 简体中文 | 日本語 | 한국어 | العربية | Bosanski | Dansk | Deutsch | Español | Français | Italiano | Norsk | Polski | Português (Brasil) | Русский | ไทย | Tiếng Việt | Türkçe | ភាសាខ្មែរ

# Stack Auth: Die Open-Source-Authentifizierungsplattform diff --git a/README.es.md b/README.es.md index 845e707b08..17f2c059dc 100644 --- a/README.es.md +++ b/README.es.md @@ -10,7 +10,7 @@

- English | 繁體中文 | 简体中文 | 日本語 | 한국어 | Deutsch | Español | Français | Italiano | Português (Brasil) + English | 繁體中文 | 简体中文 | 日本語 | 한국어 | العربية | Bosanski | Dansk | Deutsch | Español | Français | Italiano | Norsk | Polski | Português (Brasil) | Русский | ไทย | Tiếng Việt | Türkçe | ភាសាខ្មែរ

# Stack Auth: La plataforma de autenticación de código abierto diff --git a/README.fr.md b/README.fr.md index 8036092405..040a4d66b8 100644 --- a/README.fr.md +++ b/README.fr.md @@ -10,7 +10,7 @@

- English | 繁體中文 | 简体中文 | 日本語 | 한국어 | Deutsch | Español | Français | Italiano | Português (Brasil) + English | 繁體中文 | 简体中文 | 日本語 | 한국어 | العربية | Bosanski | Dansk | Deutsch | Español | Français | Italiano | Norsk | Polski | Português (Brasil) | Русский | ไทย | Tiếng Việt | Türkçe | ភាសាខ្មែរ

# Stack Auth : La plateforme d'authentification open source diff --git a/README.it.md b/README.it.md index 29e2e7ea4b..20feb7de0a 100644 --- a/README.it.md +++ b/README.it.md @@ -10,7 +10,7 @@

- English | 繁體中文 | 简体中文 | 日本語 | 한국어 | Deutsch | Español | Français | Italiano | Português (Brasil) + English | 繁體中文 | 简体中文 | 日本語 | 한국어 | العربية | Bosanski | Dansk | Deutsch | Español | Français | Italiano | Norsk | Polski | Português (Brasil) | Русский | ไทย | Tiếng Việt | Türkçe | ភាសាខ្មែរ

# Stack Auth: La piattaforma di autenticazione open-source diff --git a/README.ja.md b/README.ja.md index 23fb6c5bb1..d79034ec8e 100644 --- a/README.ja.md +++ b/README.ja.md @@ -10,7 +10,7 @@

- English | 繁體中文 | 简体中文 | 日本語 | 한국어 | Deutsch | Español | Français | Italiano | Português (Brasil) + English | 繁體中文 | 简体中文 | 日本語 | 한국어 | العربية | Bosanski | Dansk | Deutsch | Español | Français | Italiano | Norsk | Polski | Português (Brasil) | Русский | ไทย | Tiếng Việt | Türkçe | ភាសាខ្មែរ

# Stack Auth: オープンソースの認証プラットフォーム diff --git a/README.km.md b/README.km.md new file mode 100644 index 0000000000..c086366683 --- /dev/null +++ b/README.km.md @@ -0,0 +1,158 @@ +> ការបកប្រែនេះត្រូវបានបង្កើតដោយ Claude។ ប្រសិនបើអ្នកមានសំណើកែលម្អ សូមស្វាគមន៍ PR។ + +[![Stack Logo](/.github/assets/logo.png)](https://stack-auth.com) + +

+ 📘 ឯកសារ + | ☁️ កំណែពពក + | ✨ សាកល្បង + | 🎮 Discord +

+ +

+ English | 繁體中文 | 简体中文 | 日本語 | 한국어 | العربية | Bosanski | Dansk | Deutsch | Español | Français | Italiano | Norsk | Polski | Português (Brasil) | Русский | ไทย | Tiếng Việt | Türkçe | ភាសាខ្មែរ +

+ +# Stack Auth: វេទិកាផ្ទៀងផ្ទាត់អត្តសញ្ញាណប្រភពបើកចំហ + +Stack Auth គឺជាដំណោះស្រាយផ្ទៀងផ្ទាត់អត្តសញ្ញាណអ្នកប្រើប្រាស់ដែលគ្រប់គ្រងបាន។ វាងាយស្រួលសម្រាប់អ្នកអភិវឌ្ឍន៍ និងជាប្រភពបើកចំហទាំងស្រុង (មានអាជ្ញាបណ If ក្រោម MIT និង AGPL)។ + +Stack Auth អនុញ្ញាតឱ្យអ្នកចាប់ផ្តើមបានក្នុងរយៈពេលត្រឹមតែប្រាំនាទី បន្ទាប់មកអ្នកនឹងត្រៀមខ្លួនប្រើមុខងារទាំងអស់របស់វាពេលគម្រោងរបស់អ្នកកំពុងរីកចម្រើន។ សេវាគ្រប់គ្រងរបស់យើងជាជម្រើសទាំងស្រុង ហើយអ្នកអាចនាំចេញទិន្នន័យអ្នកប្រើប្រាស់ និងដំណើរការម៉ាស៊ីនដោយខ្លួនឯង ដោយឥតគិតថ្លៃ នៅពេលណាក៏បាន។ + +យើងគាំទ្រ Next.js, React និង JavaScript សម្រាប់ផ្នែកខាងមុខ រួមជាមួយ backend ណាមួយដែលអាចប្រើ [REST API](https://docs.stack-auth.com/api/overview) របស់យើង។ សូមពិនិត្យមើល[មគ្គុទ្ទេសក៍ការដំឡើង](https://docs.stack-auth.com/docs/next/getting-started/setup)របស់យើងដើម្បីចាប់ផ្តើម។ + +
+Stack Auth Setup +
+ +## តើវាខុសពី X ដោយរបៀបណា? + +សួរខ្លួនឯងអំពី `X`: + +- តើ `X` ជាប្រភពបើកចំហទេ? +- តើ `X` ងាយស្រួលសម្រាប់អ្នកអភិវឌ្ឍន៍ មានឯកសារល្អ និងអនុញ្ញាតឱ្យអ្នកចាប់ផ្តើមបានក្នុងរយៈពេលប៉ុន្មាននាទីទេ? +- ក្រៅពីការផ្ទៀងផ្ទាត់អត្តសញ្ញាណ តើ `X` ក៏ធ្វើការអនុញ្ញាត និងការគ្រប់គ្រងអ្នកប្រើប្រាស់ផងដែរទេ (សូមមើលបញ្ជីមុខងារខាងក្រោម)? + +ប្រសិនបើអ្នកឆ្លើយ "ទេ" ចំពោះសំណួរទាំងនេះ នោះគឺជាភាពខុសគ្នារវាង Stack Auth និង `X`។ + +## ✨ មុខងារ + +ដើម្បីទទួលបានការជូនដំណឹងមុនគេពេលយើងបន្ថែមមុខងារថ្មី សូមចុះឈ្មោះទទួល[ព្រឹត្តិប័ត្រព័ត៌មានរបស់យើង](https://stack-auth.beehiiv.com/subscribe)។ + +| | | +|-|:-:| +|

`` និង ``

សមាសធាតុផ្ទៀងផ្ទាត់អត្តសញ្ញាណដែលគាំទ្រ OAuth, ព័ត៌មានសម្ងាត់ពាក្យសម្ងាត់ និង magic links ជាមួយ development keys រួមគ្នាដើម្បីធ្វើឱ្យការដំឡើងលឿនជាងមុន។ សមាសធាតុទាំងអស់គាំទ្ររបៀបងងឹត/ភ្លឺ។ | Sign-in component | +|

API Next.js ដែលស្របតាមធម្មជាតិ

យើងបង្កើតលើ server components, React hooks និង route handlers។ | ![Dark/light mode](.github/assets/components.png) | +|

ផ្ទាំងគ្រប់គ្រងអ្នកប្រើប្រាស់

ផ្ទាំងគ្រប់គ្រងសម្រាប់ត្រង វិភាគ និងកែសម្រួលអ្នកប្រើប្រាស់។ ជំនួសឧបករណ៍ផ្ទៃក្នុងដំបូងដែលអ្នកត្រូវបង្កើត។ | ![User dashboard](.github/assets/dashboard.png) | +|

ការកំណត់គណនី

អនុញ្ញាតឱ្យអ្នកប្រើប្រាស់ធ្វើបច្ចុប្បន្នភាពប្រវត្តិរូប ផ្ទៀងផ្ទាត់អ៊ីមែល ឬផ្លាស់ប្តូរពាក្យសម្ងាត់។ មិនចាំបាច់ដំឡើងអ្វីទេ។ | Account settings component | +|

ការគ្រប់គ្រងច្រើនជើងនិងក្រុម

គ្រប់គ្រងអតិថិជន B2B ជាមួយរចនាសម្ព័ន្ធអង្គការដែលមានន័យ និងអាចពង្រីកបានដល់រាប់លាន។ | Selected team switcher component | +|

ការគ្រប់គ្រងការចូលប្រើតាមតួនាទី

កំណត់ក្រាភសិទ្ធិតាមចិត្ត និងផ្តល់ឱ្យអ្នកប្រើប្រាស់។ អង្គការអាចបង្កើតតួនាទីជាក់លាក់សម្រាប់អង្គការ។ | RBAC | +|

ការតភ្ជាប់ OAuth

ក្រៅពីការចូលគណនី Stack Auth ក៏អាចគ្រប់គ្រង access tokens សម្រាប់ API ភាគីទីបី ដូចជា Outlook និង Google Calendar។ វាគ្រប់គ្រងការធ្វើឱ្យ token ថ្មី និងការគ្រប់គ្រងវិសាលភាព ធ្វើឱ្យ access tokens អាចចូលប្រើបានតាមរយៈការហៅមុខងារតែមួយ។ | OAuth tokens | +|

Passkeys

គាំទ្រការផ្ទៀងផ្ទាត់អត្តសញ្ញាណដោយមិនប្រើពាក្យសម្ងាត់ ដោយប្រើ passkeys អនុញ្ញាតឱ្យអ្នកប្រើប្រាស់ចូលគណនីដោយសុវត្ថិភាពជាមួយ biometrics ឬ security keys នៅលើឧបករណ៍ទាំងអស់របស់ពួកគេ។ | OAuth tokens | +|

ការក្លែងបន្លំជាអ្នកប្រើប្រាស់

ក្លែងបន្លំជាអ្នកប្រើប្រាស់សម្រាប់ការជួសជុល និងគាំទ្រ ដោយចូលគណនីរបស់ពួកគេដូចជាអ្នកខ្លួនឯង។ | Webhooks | +|

Webhooks

ទទួលបានការជូនដំណឹងពេលអ្នកប្រើប្រាស់ប្រើផលិតផលរបស់អ្នក បង្កើតនៅលើ Svix។ | Webhooks | +|

អ៊ីមែលស្វ័យប្រវត្តិ

ផ្ញើអ៊ីមែលដែលអាចប្ដូរតាមបំណងលើព្រឹត្តិការណ៍ដូចជា ការចុះឈ្មោះ ការកំណត់ពាក្យសម្ងាត់ឡើងវិញ និងការផ្ទៀងផ្ទាត់អ៊ីមែល កែសម្រួលបានជាមួយកម្មវិធីកែ WYSIWYG។ | Email templates | +|

ការគ្រប់គ្រង session អ្នកប្រើប្រាស់ និង JWT

Stack Auth គ្រប់គ្រង refresh token, access token, JWT និង cookies ផ្តល់នូវប្រសិទ្ធភាពល្អបំផុតដោយមិនចាំបាច់ចំណាយលើការអនុវត្ត។ | User button | +|

ការផ្ទៀងផ្ទាត់អត្តសញ្ញាណ M2M

ប្រើ access tokens រយៈពេលខ្លីដើម្បីផ្ទៀងផ្ទាត់ម៉ាស៊ីនរបស់អ្នកទៅម៉ាស៊ីនផ្សេងទៀត។ | M2M authentication | + + +## 📦 ការដំឡើង និងការរៀបចំ + +ដើម្បីដំឡើង Stack Auth ក្នុងគម្រោង Next.js របស់អ្នក (សម្រាប់ React, JavaScript ឬ frameworks ផ្សេងទៀត សូមមើល[ឯកសារពេញលេញ](https://docs.stack-auth.com)របស់យើង): + +1. ដំណើរការអ្នកជំនួយការដំឡើងរបស់ Stack Auth ជាមួយពាក្យបញ្ជាខាងក្រោម: + ```bash + npx @stackframe/stack-cli@latest init + ``` + +2. បន្ទាប់មក បង្កើតគណនីនៅលើ[ផ្ទាំងគ្រប់គ្រង Stack Auth](https://app.stack-auth.com/projects) បង្កើតគម្រោងថ្មីជាមួយ API key និងចម្លងអថេរបរិស្ថានទៅក្នុងឯកសារ .env.local នៃគម្រោង Next.js របស់អ្នក: + ``` + NEXT_PUBLIC_STACK_PROJECT_ID= + NEXT_PUBLIC_STACK_PUBLISHABLE_CLIENT_KEY= + STACK_SECRET_SERVER_KEY= + ``` +3. រួចហើយ! អ្នកអាចដំណើរការកម្មវិធីរបស់អ្នកជាមួយ `npm run dev` ហើយចូលទៅ [http://localhost:3000/handler/signup](http://localhost:3000/handler/signup) ដើម្បីមើលទំព័រចុះឈ្មោះ។ អ្នកក៏អាចពិនិត្យមើលទំព័រការកំណត់គណនីនៅ [http://localhost:3000/handler/account-settings](http://localhost:3000/handler/account-settings)។ + +សូមពិនិត្យមើល[ឯកសារ](https://docs.stack-auth.com/getting-started/setup)សម្រាប់មគ្គុទ្ទេសក៍លម្អិតបន្ថែម។ + +## 🌱 គម្រោងសហគមន៍មួយចំនួនដែលបង្កើតជាមួយ Stack Auth + +មានគម្រោងផ្ទាល់ខ្លួនរបស់អ្នកទេ? យើងរីករាយក្នុងការបង្ហាញវាប្រសិនបើអ្នកបង្កើត PR ឬផ្ញើសារមកយើងនៅលើ [Discord](https://discord.stack-auth.com)។ + +### Templates +- [Stack Auth Template by Stack Auth Team](https://github.com/stack-auth/stack-auth-template) +- [Next SaaSkit by wolfgunblood](https://github.com/wolfgunblood/nextjs-saaskit) +- [SaaS Boilerplate by Robin Faraj](https://github.com/robinfaraj/saas-boilerplate) + +### Examples +- [Stack Auth Example by career-tokens](https://github.com/career-tokens/StackYCAuth) +- [Stack Auth Demo by the Stack Auth team](https://github.com/stack-auth/stack-auth/tree/dev/examples/demo) +- [Stack Auth E-Commerce Example by the Stack Auth team](https://github.com/stack-auth/stack-auth/tree/dev/examples/e-commerce) + +## 🏗 ការអភិវឌ្ឍន៍ និងការរួមចំណែក + +ផ្នែកនេះសម្រាប់អ្នកប្រសិនបើអ្នកចង់រួមចំណែកដល់គម្រោង Stack Auth ឬដំណើរការផ្ទាំងគ្រប់គ្រង Stack Auth នៅលើម៉ាស៊ីនរបស់អ្នក។ + +**សំខាន់**: សូមអាន[គោលការណ៍ណែនាំសម្រាប់ការរួមចំណែក](CONTRIBUTING.md)ដោយយកចិត្តទុកដាក់ ហើយចូលរួម [Discord របស់យើង](https://discord.stack-auth.com)ប្រសិនបើអ្នកចង់ជួយ។ + +### តម្រូវការ + +- Node v20 +- pnpm v9 +- Docker + +### ការរៀបចំ + +ចំណាំ: សូមណែនាំ RAM 24 GB+ សម្រាប់បទពិសោធន៍ការអភិវឌ្ឍន៍ដែលរលូន។ + +ក្នុង terminal ថ្មី: + +```sh +pnpm install +pnpm build:packages +pnpm codegen +pnpm restart-deps +pnpm dev + +# ក្នុង terminal ផ្សេង ដំណើរការតេស្តក្នុងរបៀបតាមដាន +pnpm test +``` + +ឥឡូវអ្នកអាចបើកទំព័រចាប់ផ្តើមសម្រាប់អ្នកអភិវឌ្ឍន៍នៅ [http://localhost:8100](http://localhost:8100)។ ពីទីនោះ អ្នកអាចចូលទៅផ្ទាំងគ្រប់គ្រងនៅ [http://localhost:8101](http://localhost:8101), API នៅលើ port 8102, សាកល្បងនៅ port 8103, ឯកសារនៅ port 8104, Inbucket (អ៊ីមែល) នៅ port 8105 និង Prisma Studio នៅ port 8106។ សូមមើលទំព័រចាប់ផ្តើមសម្រាប់បញ្ជីសេវាកម្មទាំងអស់ដែលកំពុងដំណើរការ។ + +IDE របស់អ្នកអាចបង្ហាញកំហុសនៅលើការ import `@stackframe/XYZ` ទាំងអស់។ ដើម្បីជួសជុលនេះ គ្រាន់តែចាប់ផ្តើមម៉ាស៊ីនបម្រើភាសា TypeScript ឡើងវិញ។ ឧទាហរណ៍ នៅក្នុង VSCode អ្នកអាចបើក command palette (Ctrl+Shift+P) ហើយដំណើរការ `Developer: Reload Window` ឬ `TypeScript: Restart TS server`។ + +ឯកសារ .env ដែលបានបំពេញជាមុនសម្រាប់ការរៀបចំខាងក្រោមអាចប្រើបាន និងត្រូវបានប្រើតាមលំនាំដើមនៅក្នុង `.env.development` នៅក្នុងកញ្ចប់នីមួយៗ។ ទោះជាយ៉ាងណា ប្រសិនបើអ្នកកំពុងបង្កើត production build (ឧ. ជាមួយ `pnpm run build`) អ្នកត្រូវផ្តល់អថេរបរិស្ថានដោយដៃ (សូមមើលខាងក្រោម)។ + +### ពាក្យបញ្ជាមានប្រយោជន៍ + +```sh +pnpm install +pnpm typecheck +pnpm lint +pnpm build +pnpm build:packages +pnpm codegen +pnpm dev +pnpm dev:full +pnpm dev:basic +pnpm start-deps +pnpm stop-deps +pnpm restart-deps +pnpm db:migration-gen +pnpm db:reset +pnpm db:init +pnpm db:seed +pnpm db:migrate +pnpm test +pnpm explain-query +pnpm verify-data-integrity +``` + +ចំណាំ: ពេលធ្វើការជាមួយ AI អ្នកគួរបើកផ្ទាំង terminal មួយជាមួយម៉ាស៊ីនបម្រើអភិវឌ្ឍន៍ដើម្បីឱ្យ AI អាចដំណើរការសំណួរទៅកាន់វា។ + +## ❤ អ្នករួមចំណែក + + + + diff --git a/README.ko.md b/README.ko.md index 7a4df98c6e..9f7ff32194 100644 --- a/README.ko.md +++ b/README.ko.md @@ -10,7 +10,7 @@

- English | 繁體中文 | 简体中文 | 日本語 | 한국어 | Deutsch | Español | Français | Italiano | Português (Brasil) + English | 繁體中文 | 简体中文 | 日本語 | 한국어 | العربية | Bosanski | Dansk | Deutsch | Español | Français | Italiano | Norsk | Polski | Português (Brasil) | Русский | ไทย | Tiếng Việt | Türkçe | ភាសាខ្មែរ

# Stack Auth: 오픈소스 인증 플랫폼 diff --git a/README.md b/README.md index c366b7e188..2bdb6a50c1 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@

- English | 繁體中文 | 简体中文 | 日本語 | 한국어 | Deutsch | Español | Français | Italiano | Português (Brasil) + English | 繁體中文 | 简体中文 | 日本語 | 한국어 | العربية | Bosanski | Dansk | Deutsch | Español | Français | Italiano | Norsk | Polski | Português (Brasil) | Русский | ไทย | Tiếng Việt | Türkçe | ភាសាខ្មែរ

# Stack Auth: The open-source auth platform diff --git a/README.no.md b/README.no.md new file mode 100644 index 0000000000..c13b3e4dd7 --- /dev/null +++ b/README.no.md @@ -0,0 +1,158 @@ +> Denne oversettelsen er generert av Claude. Forslag til forbedringer via PR er velkomne. + +[![Stack Logo](/.github/assets/logo.png)](https://stack-auth.com) + +

+ 📘 Dokumentasjon + | ☁️ Skytjeneste + | ✨ Demo + | 🎮 Discord +

+ +

+ English | 繁體中文 | 简体中文 | 日本語 | 한국어 | العربية | Bosanski | Dansk | Deutsch | Español | Français | Italiano | Norsk | Polski | Português (Brasil) | Русский | ไทย | Tiếng Việt | Türkçe | ភាសាខ្មែរ +

+ +# Stack Auth: Autentiseringsplattformen med åpen kildekode + +Stack Auth er en administrert løsning for brukerautentisering. Den er utviklervennlig og fullstendig åpen kildekode (lisensiert under MIT og AGPL). + +Stack Auth får deg i gang på bare fem minutter, og deretter er du klar til å bruke alle funksjonene etter hvert som prosjektet ditt vokser. Vår administrerte tjeneste er helt valgfri, og du kan eksportere brukerdataene dine og kjøre selv, gratis, når som helst. + +Vi støtter Next.js, React og JavaScript-frontender, sammen med enhver backend som kan bruke vårt [REST API](https://docs.stack-auth.com/api/overview). Sjekk ut vår [oppsettguide](https://docs.stack-auth.com/docs/next/getting-started/setup) for å komme i gang. + +
+Stack Auth Setup +
+ +## Hvordan er dette forskjellig fra X? + +Still deg selv følgende spørsmål om `X`: + +- Er `X` åpen kildekode? +- Er `X` utviklervennlig, godt dokumentert, og lar deg komme i gang på minutter? +- I tillegg til autentisering, håndterer `X` også autorisasjon og brukeradministrasjon (se funksjonslisten nedenfor)? + +Hvis du svarte "nei" på noen av disse spørsmålene, så er det slik Stack Auth skiller seg fra `X`. + +## ✨ Funksjoner + +For å bli varslet først når vi legger til nye funksjoner, vennligst abonner på [vårt nyhetsbrev](https://stack-auth.beehiiv.com/subscribe). + +| | | +|-|:-:| +|

`` og ``

Autentiseringskomponenter som støtter OAuth, passordpålogging og magiske lenker, med delte utviklingsnøkler for raskere oppsett. Alle komponenter støtter mørk/lys modus. | Sign-in component | +|

Idiomatiske Next.js-APIer

Vi bygger på serverkomponenter, React hooks og rutebehandlere. | ![Dark/light mode](.github/assets/components.png) | +|

Brukerkontrollpanel

Kontrollpanel for å filtrere, analysere og redigere brukere. Erstatter det første interne verktøyet du ellers måtte bygge. | ![User dashboard](.github/assets/dashboard.png) | +|

Kontoinnstillinger

Lar brukere oppdatere profilen sin, verifisere e-posten sin eller endre passordet sitt. Ingen oppsett nødvendig. | Account settings component | +|

Flerleietakere og team

Administrer B2B-kunder med en organisasjonsstruktur som gir mening og skalerer til millioner. | Selected team switcher component | +|

Rollebasert tilgangskontroll

Definer en vilkårlig tillatelsesstruktur og tildel den til brukere. Organisasjoner kan opprette organisasjonsspesifikke roller. | RBAC | +|

OAuth-tilkoblinger

Utover pålogging kan Stack Auth også administrere tilgangstokener for tredjeparts-APIer, som Outlook og Google Calendar. Den håndterer oppdatering av tokener og kontroll av omfang, slik at tilgangstokener er tilgjengelige via ett enkelt funksjonskall. | OAuth tokens | +|

Passnøkler

Støtte for passordløs autentisering med passnøkler, som lar brukere logge inn sikkert med biometri eller sikkerhetsnøkler på alle enhetene sine. | OAuth tokens | +|

Etterligning

Etterlign brukere for feilsøking og support, ved å logge inn på kontoen deres som om du var dem. | Webhooks | +|

Webhooks

Bli varslet når brukere bruker produktet ditt, bygget på Svix. | Webhooks | +|

Automatiske e-poster

Send tilpassbare e-poster ved hendelser som registrering, tilbakestilling av passord og e-postverifisering, redigerbare med en WYSIWYG-editor. | Email templates | +|

Brukersesjon- og JWT-håndtering

Stack Auth administrerer oppdaterings- og tilgangstokener, JWTer og informasjonskapsler, noe som gir best mulig ytelse uten implementeringskostnad. | User button | +|

M2M-autentisering

Bruk kortlevde tilgangstokener for å autentisere maskinene dine mot andre maskiner. | M2M authentication | + + +## 📦 Installasjon og oppsett + +For å installere Stack Auth i Next.js-prosjektet ditt (for React, JavaScript eller andre rammeverk, se vår [fullstendige dokumentasjon](https://docs.stack-auth.com)): + +1. Kjør Stack Auths installasjonsveiviser med følgende kommando: + ```bash + npx @stackframe/stack-cli@latest init + ``` + +2. Deretter oppretter du en konto på [Stack Auth-kontrollpanelet](https://app.stack-auth.com/projects), oppretter et nytt prosjekt med en API-nøkkel, og kopierer miljøvariablene inn i .env.local-filen i Next.js-prosjektet ditt: + ``` + NEXT_PUBLIC_STACK_PROJECT_ID= + NEXT_PUBLIC_STACK_PUBLISHABLE_CLIENT_KEY= + STACK_SECRET_SERVER_KEY= + ``` +3. Det er alt! Du kan kjøre appen din med `npm run dev` og gå til [http://localhost:3000/handler/signup](http://localhost:3000/handler/signup) for å se registreringssiden. Du kan også sjekke kontoinnstillingssiden på [http://localhost:3000/handler/account-settings](http://localhost:3000/handler/account-settings). + +Sjekk ut [dokumentasjonen](https://docs.stack-auth.com/getting-started/setup) for en mer detaljert guide. + +## 🌱 Noen fellesskapsprosjekter bygget med Stack Auth + +Har du ditt eget? Vi legger det gjerne til hvis du oppretter en PR eller sender oss en melding på [Discord](https://discord.stack-auth.com). + +### Templates +- [Stack Auth Template by Stack Auth Team](https://github.com/stack-auth/stack-auth-template) +- [Next SaaSkit by wolfgunblood](https://github.com/wolfgunblood/nextjs-saaskit) +- [SaaS Boilerplate by Robin Faraj](https://github.com/robinfaraj/saas-boilerplate) + +### Examples +- [Stack Auth Example by career-tokens](https://github.com/career-tokens/StackYCAuth) +- [Stack Auth Demo by the Stack Auth team](https://github.com/stack-auth/stack-auth/tree/dev/examples/demo) +- [Stack Auth E-Commerce Example by the Stack Auth team](https://github.com/stack-auth/stack-auth/tree/dev/examples/e-commerce) + +## 🏗 Utvikling og bidrag + +Dette er for deg hvis du ønsker å bidra til Stack Auth-prosjektet eller kjøre Stack Auth-kontrollpanelet lokalt. + +**Viktig**: Vennligst les [retningslinjene for bidrag](CONTRIBUTING.md) nøye og bli med i [vår Discord](https://discord.stack-auth.com) hvis du ønsker å hjelpe. + +### Krav + +- Node v20 +- pnpm v9 +- Docker + +### Oppsett + +Merk: 24 GB+ RAM anbefales for en smidig utviklingsopplevelse. + +I en ny terminal: + +```sh +pnpm install +pnpm build:packages +pnpm codegen +pnpm restart-deps +pnpm dev + +# I en annen terminal, kjør tester i overvåkningsmodus +pnpm test +``` + +Du kan nå åpne utviklerstartsiden på [http://localhost:8100](http://localhost:8100). Derfra kan du navigere til kontrollpanelet på [http://localhost:8101](http://localhost:8101), API på port 8102, demo på port 8103, dokumentasjon på port 8104, Inbucket (e-poster) på port 8105 og Prisma Studio på port 8106. Se utviklerstartsiden for en liste over alle kjørende tjenester. + +IDE-en din kan vise en feil på alle `@stackframe/XYZ`-importer. For å fikse dette, start bare TypeScript-språkserveren på nytt; for eksempel i VSCode kan du åpne kommandopaletten (Ctrl+Shift+P) og kjøre `Developer: Reload Window` eller `TypeScript: Restart TS server`. + +Forhåndsutfylte .env-filer for oppsettet nedenfor er tilgjengelige og brukes som standard i `.env.development` i hver av pakkene. Hvis du imidlertid lager en produksjonsbygging (f.eks. med `pnpm run build`), må du oppgi miljøvariablene manuelt (se nedenfor). + +### Nyttige kommandoer + +```sh +pnpm install +pnpm typecheck +pnpm lint +pnpm build +pnpm build:packages +pnpm codegen +pnpm dev +pnpm dev:full +pnpm dev:basic +pnpm start-deps +pnpm stop-deps +pnpm restart-deps +pnpm db:migration-gen +pnpm db:reset +pnpm db:init +pnpm db:seed +pnpm db:migrate +pnpm test +pnpm explain-query +pnpm verify-data-integrity +``` + +Merk: Når du jobber med AI, bør du holde en terminalfane med utviklingsserveren åpen slik at AI-en kan kjøre spørringer mot den. + +## ❤ Bidragsytere + + + + diff --git a/README.pl.md b/README.pl.md new file mode 100644 index 0000000000..540ca78676 --- /dev/null +++ b/README.pl.md @@ -0,0 +1,158 @@ +> To tłumaczenie zostało wygenerowane przez Claude. Sugestie ulepszeń w formie PR są mile widziane. + +[![Stack Logo](/.github/assets/logo.png)](https://stack-auth.com) + +

+ 📘 Dokumentacja + | ☁️ Wersja hostowana + | ✨ Demo + | 🎮 Discord +

+ +

+ English | 繁體中文 | 简体中文 | 日本語 | 한국어 | العربية | Bosanski | Dansk | Deutsch | Español | Français | Italiano | Norsk | Polski | Português (Brasil) | Русский | ไทย | Tiếng Việt | Türkçe | ភាសាខ្មែរ +

+ +# Stack Auth: Platforma uwierzytelniania open source + +Stack Auth to zarządzane rozwiązanie do uwierzytelniania użytkowników. Jest przyjazne dla programistów i w pełni open source (licencjonowane na MIT i AGPL). + +Stack Auth pozwala zacząć w zaledwie pięć minut, po czym będziesz mógł korzystać ze wszystkich funkcji w miarę rozwoju projektu. Nasza usługa zarządzana jest całkowicie opcjonalna, a Ty możesz wyeksportować dane użytkowników i hostować samodzielnie, za darmo, w dowolnym momencie. + +Obsługujemy frontendy Next.js, React i JavaScript, a także dowolny backend, który może korzystać z naszego [REST API](https://docs.stack-auth.com/api/overview). Sprawdź nasz [przewodnik konfiguracji](https://docs.stack-auth.com/docs/next/getting-started/setup), aby zacząć. + +
+Stack Auth Setup +
+ +## Czym to się różni od X? + +Zadaj sobie pytania o `X`: + +- Czy `X` jest open source? +- Czy `X` jest przyjazny dla programistów, dobrze udokumentowany i pozwala zacząć w kilka minut? +- Czy oprócz uwierzytelniania `X` oferuje również autoryzację i zarządzanie użytkownikami (zobacz listę funkcji poniżej)? + +Jeśli na którekolwiek z tych pytań odpowiedziałeś "nie", to właśnie tym Stack Auth różni się od `X`. + +## ✨ Funkcje + +Aby otrzymywać powiadomienia o nowych funkcjach jako pierwszy, zapisz się do [naszego newslettera](https://stack-auth.beehiiv.com/subscribe). + +| | | +|-|:-:| +|

`` i ``

Komponenty uwierzytelniania obsługujące OAuth, logowanie hasłem i magic links, ze współdzielonymi kluczami deweloperskimi dla szybszej konfiguracji. Wszystkie komponenty obsługują tryb ciemny/jasny. | Sign-in component | +|

Idiomatyczne API Next.js

Budujemy na server components, React hooks i route handlers. | ![Dark/light mode](.github/assets/components.png) | +|

Panel użytkowników

Panel do filtrowania, analizowania i edycji użytkowników. Zastępuje pierwsze narzędzie wewnętrzne, które musiałbyś zbudować. | ![User dashboard](.github/assets/dashboard.png) | +|

Ustawienia konta

Pozwala użytkownikom aktualizować profil, weryfikować e-mail lub zmieniać hasło. Bez dodatkowej konfiguracji. | Account settings component | +|

Multi-tenancy i zespoły

Zarządzaj klientami B2B ze strukturą organizacyjną, która ma sens i skaluje się do milionów. | Selected team switcher component | +|

Kontrola dostępu oparta na rolach

Zdefiniuj dowolny graf uprawnień i przypisz go użytkownikom. Organizacje mogą tworzyć role specyficzne dla organizacji. | RBAC | +|

Połączenia OAuth

Oprócz logowania Stack Auth może również zarządzać tokenami dostępu do API firm trzecich, takich jak Outlook i Google Calendar. Obsługuje odświeżanie tokenów i kontrolę zakresu, udostępniając tokeny dostępu za pomocą jednego wywołania funkcji. | OAuth tokens | +|

Passkeys

Obsługa uwierzytelniania bez hasła za pomocą passkeys, umożliwiająca użytkownikom bezpieczne logowanie biometrią lub kluczami bezpieczeństwa na wszystkich urządzeniach. | OAuth tokens | +|

Personifikacja użytkowników

Personifikuj użytkowników w celach debugowania i wsparcia, logując się na ich konto tak, jakbyś był nimi. | Webhooks | +|

Webhooks

Otrzymuj powiadomienia, gdy użytkownicy korzystają z Twojego produktu, zbudowane na Svix. | Webhooks | +|

Automatyczne e-maile

Wysyłaj konfigurowalne e-maile przy zdarzeniach takich jak rejestracja, reset hasła i weryfikacja e-mail, edytowalne za pomocą edytora WYSIWYG. | Email templates | +|

Obsługa sesji użytkownika i JWT

Stack Auth zarządza tokenami odświeżania i dostępu, JWT i ciasteczkami, zapewniając najlepszą wydajność bez kosztów implementacji. | User button | +|

Uwierzytelnianie M2M

Używaj krótkoterminowych tokenów dostępu do uwierzytelniania maszyn między sobą. | M2M authentication | + + +## 📦 Instalacja i konfiguracja + +Aby zainstalować Stack Auth w projekcie Next.js (dla React, JavaScript lub innych frameworków, zobacz [pełną dokumentację](https://docs.stack-auth.com)): + +1. Uruchom kreator instalacji Stack Auth następującym poleceniem: + ```bash + npx @stackframe/stack-cli@latest init + ``` + +2. Następnie utwórz konto na [panelu Stack Auth](https://app.stack-auth.com/projects), utwórz nowy projekt z kluczem API i skopiuj zmienne środowiskowe do pliku .env.local w projekcie Next.js: + ``` + NEXT_PUBLIC_STACK_PROJECT_ID= + NEXT_PUBLIC_STACK_PUBLISHABLE_CLIENT_KEY= + STACK_SECRET_SERVER_KEY= + ``` +3. To wszystko! Możesz uruchomić aplikację za pomocą `npm run dev` i przejść do [http://localhost:3000/handler/signup](http://localhost:3000/handler/signup), aby zobaczyć stronę rejestracji. Możesz też sprawdzić stronę ustawień konta pod adresem [http://localhost:3000/handler/account-settings](http://localhost:3000/handler/account-settings). + +Sprawdź [dokumentację](https://docs.stack-auth.com/getting-started/setup), aby uzyskać bardziej szczegółowy przewodnik. + +## 🌱 Wybrane projekty społeczności zbudowane ze Stack Auth + +Masz własny projekt? Chętnie go wyróżnimy, jeśli utworzysz PR lub napiszesz do nas na [Discord](https://discord.stack-auth.com). + +### Templates +- [Stack Auth Template by Stack Auth Team](https://github.com/stack-auth/stack-auth-template) +- [Next SaaSkit by wolfgunblood](https://github.com/wolfgunblood/nextjs-saaskit) +- [SaaS Boilerplate by Robin Faraj](https://github.com/robinfaraj/saas-boilerplate) + +### Examples +- [Stack Auth Example by career-tokens](https://github.com/career-tokens/StackYCAuth) +- [Stack Auth Demo by the Stack Auth team](https://github.com/stack-auth/stack-auth/tree/dev/examples/demo) +- [Stack Auth E-Commerce Example by the Stack Auth team](https://github.com/stack-auth/stack-auth/tree/dev/examples/e-commerce) + +## 🏗 Rozwój i wkład + +Ta sekcja jest dla Ciebie, jeśli chcesz wnieść wkład w projekt Stack Auth lub uruchomić panel Stack Auth lokalnie. + +**Ważne**: Przeczytaj uważnie [wytyczne dotyczące wkładu](CONTRIBUTING.md) i dołącz do [naszego Discorda](https://discord.stack-auth.com), jeśli chcesz pomóc. + +### Wymagania + +- Node v20 +- pnpm v9 +- Docker + +### Konfiguracja + +Uwaga: Zalecane jest 24GB+ RAM dla płynnego doświadczenia programistycznego. + +W nowym terminalu: + +```sh +pnpm install +pnpm build:packages +pnpm codegen +pnpm restart-deps +pnpm dev + +# W innym terminalu uruchom testy w trybie obserwowania +pnpm test +``` + +Teraz możesz otworzyć stronę startową deweloperską pod adresem [http://localhost:8100](http://localhost:8100). Stamtąd możesz przejść do panelu pod [http://localhost:8101](http://localhost:8101), API na porcie 8102, demo na porcie 8103, dokumentacji na porcie 8104, Inbucket (e-maile) na porcie 8105 i Prisma Studio na porcie 8106. Zobacz stronę startową deweloperską, aby zobaczyć listę wszystkich uruchomionych usług. + +Twoje IDE może wyświetlać błąd na wszystkich importach `@stackframe/XYZ`. Aby to naprawić, po prostu uruchom ponownie TypeScript language server; na przykład w VSCode możesz otworzyć paletę poleceń (Ctrl+Shift+P) i uruchomić `Developer: Reload Window` lub `TypeScript: Restart TS server`. + +Wstępnie wypełnione pliki .env dla poniższej konfiguracji są dostępne i używane domyślnie w `.env.development` w każdym z pakietów. Jeśli jednak tworzysz build produkcyjny (np. za pomocą `pnpm run build`), musisz dostarczyć zmienne środowiskowe ręcznie (patrz poniżej). + +### Przydatne polecenia + +```sh +pnpm install +pnpm typecheck +pnpm lint +pnpm build +pnpm build:packages +pnpm codegen +pnpm dev +pnpm dev:full +pnpm dev:basic +pnpm start-deps +pnpm stop-deps +pnpm restart-deps +pnpm db:migration-gen +pnpm db:reset +pnpm db:init +pnpm db:seed +pnpm db:migrate +pnpm test +pnpm explain-query +pnpm verify-data-integrity +``` + +Uwaga: Pracując z AI, warto mieć otwartą kartę terminala z dev serverem, aby AI mogło wykonywać zapytania. + +## ❤ Współtwórcy + + + + diff --git a/README.pt-BR.md b/README.pt-BR.md index 3ca0bcae68..5566126b7f 100644 --- a/README.pt-BR.md +++ b/README.pt-BR.md @@ -10,7 +10,7 @@

- English | 繁體中文 | 简体中文 | 日本語 | 한국어 | Deutsch | Español | Français | Italiano | Português (Brasil) + English | 繁體中文 | 简体中文 | 日本語 | 한국어 | العربية | Bosanski | Dansk | Deutsch | Español | Français | Italiano | Norsk | Polski | Português (Brasil) | Русский | ไทย | Tiếng Việt | Türkçe | ភាសាខ្មែរ

# Stack Auth: A plataforma de autenticação open-source diff --git a/README.ru.md b/README.ru.md new file mode 100644 index 0000000000..e830c03187 --- /dev/null +++ b/README.ru.md @@ -0,0 +1,158 @@ +> Этот перевод сгенерирован Claude. Если у вас есть предложения по улучшению, PR приветствуются. + +[![Stack Logo](/.github/assets/logo.png)](https://stack-auth.com) + +

+ 📘 Документация + | ☁️ Облачная версия + | ✨ Демо + | 🎮 Discord +

+ +

+ English | 繁體中文 | 简体中文 | 日本語 | 한국어 | العربية | Bosanski | Dansk | Deutsch | Español | Français | Italiano | Norsk | Polski | Português (Brasil) | Русский | ไทย | Tiếng Việt | Türkçe | ភាសាខ្មែរ +

+ +# Stack Auth: платформа аутентификации с открытым исходным кодом + +Stack Auth — это управляемое решение для аутентификации пользователей. Оно удобно для разработчиков и полностью открыто (лицензировано под MIT и AGPL). + +Stack Auth позволяет начать работу всего за пять минут, после чего вы сможете использовать все его возможности по мере роста вашего проекта. Наш управляемый сервис полностью опционален, и вы можете экспортировать данные пользователей и разместить систему самостоятельно, бесплатно, в любое время. + +Мы поддерживаем фронтенды на Next.js, React и JavaScript, а также любой бэкенд, который может использовать наш [REST API](https://docs.stack-auth.com/api/overview). Ознакомьтесь с нашим [руководством по настройке](https://docs.stack-auth.com/docs/next/getting-started/setup), чтобы начать. + +
+Stack Auth Setup +
+ +## Чем это отличается от X? + +Задайте себе вопросы о `X`: + +- Является ли `X` проектом с открытым исходным кодом? +- Удобен ли `X` для разработчиков, хорошо ли задокументирован, и можно ли начать работу за считанные минуты? +- Помимо аутентификации, поддерживает ли `X` также авторизацию и управление пользователями (см. список функций ниже)? + +Если вы ответили «нет» на любой из этих вопросов, то именно этим Stack Auth отличается от `X`. + +## ✨ Возможности + +Чтобы первыми узнавать о новых функциях, подпишитесь на [нашу рассылку](https://stack-auth.beehiiv.com/subscribe). + +| | | +|-|:-:| +|

`` и ``

Компоненты аутентификации, поддерживающие OAuth, вход по паролю и магические ссылки, с общими ключами разработки для ускорения настройки. Все компоненты поддерживают тёмную и светлую темы. | Sign-in component | +|

Идиоматичные API для Next.js

Мы используем серверные компоненты, хуки React и обработчики маршрутов. | ![Dark/light mode](.github/assets/components.png) | +|

Панель управления пользователями

Панель для фильтрации, анализа и редактирования пользователей. Заменяет первый внутренний инструмент, который вам пришлось бы создавать. | ![User dashboard](.github/assets/dashboard.png) | +|

Настройки аккаунта

Позволяет пользователям обновлять профиль, подтверждать электронную почту или менять пароль. Настройка не требуется. | Account settings component | +|

Мультиарендность и команды

Управляйте B2B-клиентами с помощью организационной структуры, которая логична и масштабируется до миллионов. | Selected team switcher component | +|

Управление доступом на основе ролей

Определите произвольный граф разрешений и назначьте его пользователям. Организации могут создавать роли, специфичные для организации. | RBAC | +|

OAuth-подключения

Помимо входа в систему, Stack Auth также может управлять токенами доступа для сторонних API, таких как Outlook и Google Calendar. Он обрабатывает обновление токенов и управление областями действия, делая токены доступа доступными через один вызов функции. | OAuth tokens | +|

Passkeys

Поддержка беспарольной аутентификации с помощью passkeys, позволяющая пользователям безопасно входить в систему с помощью биометрии или аппаратных ключей безопасности на всех их устройствах. | OAuth tokens | +|

Имперсонация

Имперсонируйте пользователей для отладки и поддержки, входя в их аккаунт, как если бы вы были ими. | Webhooks | +|

Вебхуки

Получайте уведомления, когда пользователи используют ваш продукт, на базе Svix. | Webhooks | +|

Автоматические письма

Отправляйте настраиваемые письма по триггерам, таким как регистрация, сброс пароля и подтверждение электронной почты, редактируемые с помощью WYSIWYG-редактора. | Email templates | +|

Управление сессиями и JWT

Stack Auth управляет токенами обновления и доступа, JWT и куками, обеспечивая лучшую производительность без затрат на реализацию. | User button | +|

Аутентификация между машинами (M2M)

Используйте краткосрочные токены доступа для аутентификации ваших машин на других машинах. | M2M authentication | + + +## 📦 Установка и настройка + +Чтобы установить Stack Auth в вашем проекте на Next.js (для React, JavaScript или других фреймворков см. нашу [полную документацию](https://docs.stack-auth.com)): + +1. Запустите мастер установки Stack Auth следующей командой: + ```bash + npx @stackframe/stack-cli@latest init + ``` + +2. Затем создайте аккаунт на [панели управления Stack Auth](https://app.stack-auth.com/projects), создайте новый проект с API-ключом и скопируйте его переменные окружения в файл .env.local вашего проекта Next.js: + ``` + NEXT_PUBLIC_STACK_PROJECT_ID= + NEXT_PUBLIC_STACK_PUBLISHABLE_CLIENT_KEY= + STACK_SECRET_SERVER_KEY= + ``` +3. Готово! Вы можете запустить приложение с помощью `npm run dev` и перейти по адресу [http://localhost:3000/handler/signup](http://localhost:3000/handler/signup), чтобы увидеть страницу регистрации. Вы также можете посмотреть страницу настроек аккаунта по адресу [http://localhost:3000/handler/account-settings](http://localhost:3000/handler/account-settings). + +Ознакомьтесь с [документацией](https://docs.stack-auth.com/getting-started/setup) для более подробного руководства. + +## 🌱 Проекты сообщества, созданные с помощью Stack Auth + +Есть свой проект? Мы будем рады добавить его, если вы создадите PR или напишете нам в [Discord](https://discord.stack-auth.com). + +### Templates +- [Stack Auth Template by Stack Auth Team](https://github.com/stack-auth/stack-auth-template) +- [Next SaaSkit by wolfgunblood](https://github.com/wolfgunblood/nextjs-saaskit) +- [SaaS Boilerplate by Robin Faraj](https://github.com/robinfaraj/saas-boilerplate) + +### Examples +- [Stack Auth Example by career-tokens](https://github.com/career-tokens/StackYCAuth) +- [Stack Auth Demo by the Stack Auth team](https://github.com/stack-auth/stack-auth/tree/dev/examples/demo) +- [Stack Auth E-Commerce Example by the Stack Auth team](https://github.com/stack-auth/stack-auth/tree/dev/examples/e-commerce) + +## 🏗 Разработка и участие + +Этот раздел для вас, если вы хотите внести вклад в проект Stack Auth или запустить панель управления Stack Auth локально. + +**Важно**: пожалуйста, внимательно прочитайте [руководство по участию](CONTRIBUTING.md) и присоединяйтесь к [нашему Discord](https://discord.stack-auth.com), если хотите помочь. + +### Требования + +- Node v20 +- pnpm v9 +- Docker + +### Настройка + +Примечание: для комфортной разработки рекомендуется 24 ГБ+ оперативной памяти. + +В новом терминале: + +```sh +pnpm install +pnpm build:packages +pnpm codegen +pnpm restart-deps +pnpm dev + +# В другом терминале запустите тесты в режиме наблюдения +pnpm test +``` + +Теперь вы можете открыть панель разработки по адресу [http://localhost:8100](http://localhost:8100). Оттуда вы можете перейти к панели управления по адресу [http://localhost:8101](http://localhost:8101), API на порту 8102, демо на порту 8103, документация на порту 8104, Inbucket (электронная почта) на порту 8105 и Prisma Studio на порту 8106. См. панель разработки для списка всех запущенных сервисов. + +Ваша IDE может показывать ошибку на всех импортах `@stackframe/XYZ`. Чтобы это исправить, просто перезапустите языковой сервер TypeScript; например, в VSCode вы можете открыть палитру команд (Ctrl+Shift+P) и выполнить `Developer: Reload Window` или `TypeScript: Restart TS server`. + +Предзаполненные файлы .env для настройки ниже доступны и используются по умолчанию в `.env.development` в каждом из пакетов. Однако, если вы создаёте продакшн-сборку (например, с помощью `pnpm run build`), вы должны указать переменные окружения вручную (см. ниже). + +### Полезные команды + +```sh +pnpm install +pnpm typecheck +pnpm lint +pnpm build +pnpm build:packages +pnpm codegen +pnpm dev +pnpm dev:full +pnpm dev:basic +pnpm start-deps +pnpm stop-deps +pnpm restart-deps +pnpm db:migration-gen +pnpm db:reset +pnpm db:init +pnpm db:seed +pnpm db:migrate +pnpm test +pnpm explain-query +pnpm verify-data-integrity +``` + +Примечание: при работе с ИИ рекомендуется держать открытой вкладку терминала с dev-сервером, чтобы ИИ мог выполнять запросы к нему. + +## ❤ Участники + + + + diff --git a/README.th.md b/README.th.md new file mode 100644 index 0000000000..3e43a57a77 --- /dev/null +++ b/README.th.md @@ -0,0 +1,158 @@ +> การแปลนี้สร้างโดย Claude หากคุณมีข้อเสนอแนะในการปรับปรุง ยินดีรับ PR + +[![Stack Logo](/.github/assets/logo.png)](https://stack-auth.com) + +

+ 📘 เอกสาร + | ☁️ เวอร์ชันคลาวด์ + | ✨ สาธิต + | 🎮 Discord +

+ +

+ English | 繁體中文 | 简体中文 | 日本語 | 한국어 | العربية | Bosanski | Dansk | Deutsch | Español | Français | Italiano | Norsk | Polski | Português (Brasil) | Русский | ไทย | Tiếng Việt | Türkçe | ភាសាខ្មែរ +

+ +# Stack Auth: แพลตฟอร์มยืนยันตัวตนแบบโอเพนซอร์ส + +Stack Auth เป็นโซลูชันการยืนยันตัวตนผู้ใช้แบบจัดการ เป็นมิตรกับนักพัฒนาและเปิดเผยซอร์สโค้ดทั้งหมด (ลิขสิทธิ์ภายใต้ MIT และ AGPL) + +Stack Auth ช่วยให้คุณเริ่มต้นได้ภายในเพียงห้านาที หลังจากนั้นคุณจะพร้อมใช้ฟีเจอร์ทั้งหมดในขณะที่โปรเจกต์ของคุณเติบโต บริการจัดการของเราเป็นทางเลือกอย่างสมบูรณ์ และคุณสามารถส่งออกข้อมูลผู้ใช้และโฮสต์เองได้ฟรีตลอดเวลา + +เรารองรับ Next.js, React และ JavaScript สำหรับฝั่งหน้าบ้าน รวมถึงแบ็กเอนด์ใดก็ได้ที่สามารถใช้ [REST API](https://docs.stack-auth.com/api/overview) ของเรา ดู[คู่มือการตั้งค่า](https://docs.stack-auth.com/docs/next/getting-started/setup)ของเราเพื่อเริ่มต้นใช้งาน + +
+Stack Auth Setup +
+ +## สิ่งนี้แตกต่างจาก X อย่างไร? + +ลองถามตัวเองเกี่ยวกับ `X`: + +- `X` เป็นโอเพนซอร์สหรือไม่? +- `X` เป็นมิตรกับนักพัฒนา มีเอกสารครบถ้วน และให้คุณเริ่มต้นได้ภายในไม่กี่นาทีหรือไม่? +- นอกจากการยืนยันตัวตนแล้ว `X` ยังทำการอนุญาตและการจัดการผู้ใช้ด้วยหรือไม่ (ดูรายการฟีเจอร์ด้านล่าง)? + +หากคุณตอบ "ไม่" กับข้อใดข้อหนึ่ง นั่นคือความแตกต่างระหว่าง Stack Auth กับ `X` + +## ✨ ฟีเจอร์ + +หากต้องการรับการแจ้งเตือนเป็นคนแรกเมื่อเราเพิ่มฟีเจอร์ใหม่ กรุณาสมัครรับ[จดหมายข่าวของเรา](https://stack-auth.beehiiv.com/subscribe) + +| | | +|-|:-:| +|

`` และ ``

คอมโพเนนต์ยืนยันตัวตนที่รองรับ OAuth, ข้อมูลรับรองแบบรหัสผ่าน และลิงก์มายากล พร้อมคีย์พัฒนาร่วมเพื่อให้ตั้งค่าได้เร็วขึ้น คอมโพเนนต์ทั้งหมดรองรับโหมดมืด/สว่าง | Sign-in component | +|

API แบบ Next.js ที่เป็นธรรมชาติ

เราสร้างบนเซิร์ฟเวอร์คอมโพเนนต์, React hooks และ route handlers | ![Dark/light mode](.github/assets/components.png) | +|

แดชบอร์ดผู้ใช้

แดชบอร์ดสำหรับกรอง วิเคราะห์ และแก้ไขผู้ใช้ ทดแทนเครื่องมือภายในชิ้นแรกที่คุณต้องสร้าง | ![User dashboard](.github/assets/dashboard.png) | +|

การตั้งค่าบัญชี

ให้ผู้ใช้อัปเดตโปรไฟล์ ยืนยันอีเมล หรือเปลี่ยนรหัสผ่าน ไม่ต้องตั้งค่าใดๆ | Account settings component | +|

การรองรับหลายผู้เช่าและทีม

จัดการลูกค้า B2B ด้วยโครงสร้างองค์กรที่เข้าใจง่ายและรองรับได้ถึงหลายล้าน | Selected team switcher component | +|

การควบคุมการเข้าถึงตามบทบาท

กำหนดกราฟสิทธิ์ตามต้องการและกำหนดให้กับผู้ใช้ องค์กรสามารถสร้างบทบาทเฉพาะขององค์กรได้ | RBAC | +|

การเชื่อมต่อ OAuth

นอกเหนือจากการเข้าสู่ระบบ Stack Auth ยังสามารถจัดการโทเค็นการเข้าถึงสำหรับ API ของบุคคลที่สาม เช่น Outlook และ Google Calendar ระบบจัดการการรีเฟรชโทเค็นและการควบคุมขอบเขต ทำให้โทเค็นการเข้าถึงเรียกใช้ได้ผ่านฟังก์ชันเดียว | OAuth tokens | +|

Passkeys

รองรับการยืนยันตัวตนแบบไม่ใช้รหัสผ่านด้วย passkeys ช่วยให้ผู้ใช้เข้าสู่ระบบได้อย่างปลอดภัยด้วยไบโอเมตริกซ์หรือคีย์ความปลอดภัยบนอุปกรณ์ทุกเครื่อง | OAuth tokens | +|

การแอบอ้างเป็นผู้ใช้

แอบอ้างเป็นผู้ใช้เพื่อการดีบักและสนับสนุน โดยเข้าสู่ระบบในบัญชีของพวกเขาเสมือนเป็นตัวพวกเขาเอง | Webhooks | +|

Webhooks

รับการแจ้งเตือนเมื่อผู้ใช้ใช้งานผลิตภัณฑ์ของคุณ สร้างบน Svix | Webhooks | +|

อีเมลอัตโนมัติ

ส่งอีเมลที่ปรับแต่งได้เมื่อเกิดเหตุการณ์ เช่น การลงทะเบียน การรีเซ็ตรหัสผ่าน และการยืนยันอีเมล แก้ไขได้ด้วยตัวแก้ไข WYSIWYG | Email templates | +|

การจัดการเซสชันผู้ใช้และ JWT

Stack Auth จัดการ refresh token, access token, JWT และคุกกี้ ให้ประสิทธิภาพสูงสุดโดยไม่ต้องลงทุนในการพัฒนา | User button | +|

การยืนยันตัวตนแบบ M2M

ใช้ access token ที่มีอายุสั้นเพื่อยืนยันตัวตนเครื่องของคุณกับเครื่องอื่น | M2M authentication | + + +## 📦 การติดตั้งและตั้งค่า + +หากต้องการติดตั้ง Stack Auth ในโปรเจกต์ Next.js ของคุณ (สำหรับ React, JavaScript หรือเฟรมเวิร์กอื่นๆ ดู[เอกสารฉบับสมบูรณ์](https://docs.stack-auth.com)ของเรา): + +1. รันตัวช่วยติดตั้งของ Stack Auth ด้วยคำสั่งต่อไปนี้: + ```bash + npx @stackframe/stack-cli@latest init + ``` + +2. จากนั้น สร้างบัญชีบน[แดชบอร์ด Stack Auth](https://app.stack-auth.com/projects) สร้างโปรเจกต์ใหม่พร้อมคีย์ API และคัดลอกตัวแปรสภาพแวดล้อมลงในไฟล์ .env.local ของโปรเจกต์ Next.js ของคุณ: + ``` + NEXT_PUBLIC_STACK_PROJECT_ID= + NEXT_PUBLIC_STACK_PUBLISHABLE_CLIENT_KEY= + STACK_SECRET_SERVER_KEY= + ``` +3. เท่านั้นเอง! คุณสามารถรันแอปด้วย `npm run dev` และไปที่ [http://localhost:3000/handler/signup](http://localhost:3000/handler/signup) เพื่อดูหน้าลงทะเบียน คุณยังสามารถดูหน้าการตั้งค่าบัญชีได้ที่ [http://localhost:3000/handler/account-settings](http://localhost:3000/handler/account-settings) + +ดู[เอกสาร](https://docs.stack-auth.com/getting-started/setup)สำหรับคู่มือที่ละเอียดยิ่งขึ้น + +## 🌱 โปรเจกต์จากชุมชนที่สร้างด้วย Stack Auth + +มีโปรเจกต์ของคุณเอง? ยินดีที่จะนำเสนอหากคุณสร้าง PR หรือส่งข้อความถึงเราบน [Discord](https://discord.stack-auth.com) + +### Templates +- [Stack Auth Template by Stack Auth Team](https://github.com/stack-auth/stack-auth-template) +- [Next SaaSkit by wolfgunblood](https://github.com/wolfgunblood/nextjs-saaskit) +- [SaaS Boilerplate by Robin Faraj](https://github.com/robinfaraj/saas-boilerplate) + +### Examples +- [Stack Auth Example by career-tokens](https://github.com/career-tokens/StackYCAuth) +- [Stack Auth Demo by the Stack Auth team](https://github.com/stack-auth/stack-auth/tree/dev/examples/demo) +- [Stack Auth E-Commerce Example by the Stack Auth team](https://github.com/stack-auth/stack-auth/tree/dev/examples/e-commerce) + +## 🏗 การพัฒนาและการมีส่วนร่วม + +ส่วนนี้สำหรับคุณหากต้องการมีส่วนร่วมในโปรเจกต์ Stack Auth หรือรันแดชบอร์ด Stack Auth บนเครื่องของคุณ + +**สำคัญ**: กรุณาอ่าน[แนวทางการมีส่วนร่วม](CONTRIBUTING.md)อย่างละเอียดและเข้าร่วม[Discord ของเรา](https://discord.stack-auth.com)หากคุณต้องการช่วยเหลือ + +### ความต้องการ + +- Node v20 +- pnpm v9 +- Docker + +### การตั้งค่า + +หมายเหตุ: แนะนำ RAM 24 GB ขึ้นไปเพื่อประสบการณ์การพัฒนาที่ราบรื่น + +ในเทอร์มินัลใหม่: + +```sh +pnpm install +pnpm build:packages +pnpm codegen +pnpm restart-deps +pnpm dev + +# ในเทอร์มินัลอื่น รันการทดสอบในโหมดเฝ้าดู +pnpm test +``` + +ตอนนี้คุณสามารถเปิดหน้าเริ่มต้นการพัฒนาได้ที่ [http://localhost:8100](http://localhost:8100) จากที่นั่นคุณสามารถไปที่แดชบอร์ดที่ [http://localhost:8101](http://localhost:8101), API บนพอร์ต 8102, สาธิตบนพอร์ต 8103, เอกสารบนพอร์ต 8104, Inbucket (อีเมล) บนพอร์ต 8105 และ Prisma Studio บนพอร์ต 8106 ดูหน้าเริ่มต้นการพัฒนาสำหรับรายการบริการทั้งหมดที่กำลังทำงาน + +IDE ของคุณอาจแสดงข้อผิดพลาดในทุกการ import `@stackframe/XYZ` ในการแก้ไข ให้รีสตาร์ทเซิร์ฟเวอร์ภาษา TypeScript เช่น ใน VSCode คุณสามารถเปิดคอมมานด์พาเลทท์ (Ctrl+Shift+P) และรัน `Developer: Reload Window` หรือ `TypeScript: Restart TS server` + +ไฟล์ .env ที่กรอกข้อมูลไว้ล่วงหน้าสำหรับการตั้งค่าด้านล่างมีให้ใช้และถูกใช้เป็นค่าเริ่มต้นใน `.env.development` ในแต่ละแพ็กเกจ อย่างไรก็ตาม หากคุณสร้างบิลด์สำหรับโปรดักชัน (เช่น ด้วย `pnpm run build`) คุณต้องระบุตัวแปรสภาพแวดล้อมด้วยตัวเอง (ดูด้านล่าง) + +### คำสั่งที่มีประโยชน์ + +```sh +pnpm install +pnpm typecheck +pnpm lint +pnpm build +pnpm build:packages +pnpm codegen +pnpm dev +pnpm dev:full +pnpm dev:basic +pnpm start-deps +pnpm stop-deps +pnpm restart-deps +pnpm db:migration-gen +pnpm db:reset +pnpm db:init +pnpm db:seed +pnpm db:migrate +pnpm test +pnpm explain-query +pnpm verify-data-integrity +``` + +หมายเหตุ: เมื่อทำงานกับ AI คุณควรเปิดแท็บเทอร์มินัลที่มีเซิร์ฟเวอร์พัฒนาไว้เพื่อให้ AI สามารถรันคิวรีได้ + +## ❤ ผู้มีส่วนร่วม + + + + diff --git a/README.tr.md b/README.tr.md new file mode 100644 index 0000000000..94ae1ee58b --- /dev/null +++ b/README.tr.md @@ -0,0 +1,158 @@ +> Bu çeviri Claude tarafından oluşturulmuştur. İyileştirme önerileriniz varsa PR'lar memnuniyetle karşılanır. + +[![Stack Logo](/.github/assets/logo.png)](https://stack-auth.com) + +

+ 📘 Dokümantasyon + | ☁️ Bulut Sürümü + | ✨ Demo + | 🎮 Discord +

+ +

+ English | 繁體中文 | 简体中文 | 日本語 | 한국어 | العربية | Bosanski | Dansk | Deutsch | Español | Français | Italiano | Norsk | Polski | Português (Brasil) | Русский | ไทย | Tiếng Việt | Türkçe | ភាសាខ្មែរ +

+ +# Stack Auth: Açık kaynaklı kimlik doğrulama platformu + +Stack Auth, yönetilen bir kullanıcı kimlik doğrulama çözümüdür. Geliştirici dostudur ve tamamen açık kaynaktır (MIT ve AGPL lisansları altında). + +Stack Auth ile sadece beş dakikada başlayabilirsiniz, ardından projeniz büyüdükçe tüm özelliklerini kullanmaya hazır olursunuz. Yönetilen hizmetimiz tamamen isteğe bağlıdır ve kullanıcı verilerinizi dışa aktararak istediğiniz zaman ücretsiz olarak kendi sunucunuzda barındırabilirsiniz. + +Next.js, React ve JavaScript ön yüzlerini, ayrıca [REST API](https://docs.stack-auth.com/api/overview)'mizi kullanabilen herhangi bir arka ucu destekliyoruz. Başlamak için [kurulum kılavuzumuza](https://docs.stack-auth.com/docs/next/getting-started/setup) göz atın. + +
+Stack Auth Setup +
+ +## Bu X'ten nasıl farklı? + +Kendinize `X` hakkında şunu sorun: + +- `X` açık kaynaklı mı? +- `X` geliştirici dostu mu, iyi belgelenmiş mi ve dakikalar içinde başlamanızı sağlıyor mu? +- Kimlik doğrulamanın yanı sıra, `X` yetkilendirme ve kullanıcı yönetimi de yapıyor mu (aşağıdaki özellik listesine bakın)? + +Bu sorulardan herhangi birine "hayır" cevabı verdiyseniz, Stack Auth'un `X`'ten farkı işte budur. + +## ✨ Özellikler + +Yeni özellikler eklediğimizde ilk haberdar olmak için lütfen [bültenimize](https://stack-auth.beehiiv.com/subscribe) abone olun. + +| | | +|-|:-:| +|

`` ve ``

OAuth, parola kimlik bilgileri ve sihirli bağlantıları destekleyen, kurulumu hızlandırmak için paylaşımlı geliştirme anahtarlarına sahip kimlik doğrulama bileşenleri. Tüm bileşenler koyu/açık mod desteğine sahiptir. | Sign-in component | +|

Deyimsel Next.js API'leri

Sunucu bileşenleri, React hooks ve rota işleyicileri üzerine inşa ediyoruz. | ![Dark/light mode](.github/assets/components.png) | +|

Kullanıcı kontrol paneli

Kullanıcıları filtrelemek, analiz etmek ve düzenlemek için kontrol paneli. Oluşturmanız gereken ilk dahili aracın yerini alır. | ![User dashboard](.github/assets/dashboard.png) | +|

Hesap ayarları

Kullanıcıların profillerini güncellemelerine, e-postalarını doğrulamalarına veya parolalarını değiştirmelerine olanak tanır. Kurulum gerektirmez. | Account settings component | +|

Çok kiracılılık ve takımlar

B2B müşterilerini mantıklı ve milyonlara ölçeklenebilen bir organizasyon yapısıyla yönetin. | Selected team switcher component | +|

Rol tabanlı erişim kontrolü

İsteğe bağlı bir izin grafiği tanımlayın ve kullanıcılara atayın. Organizasyonlar, organizasyona özel roller oluşturabilir. | RBAC | +|

OAuth Bağlantıları

Giriş yapmanın ötesinde, Stack Auth ayrıca Outlook ve Google Calendar gibi üçüncü taraf API'ler için erişim tokenlarını yönetebilir. Token yenileme ve kapsam kontrolünü yönetir, erişim tokenlarını tek bir fonksiyon çağrısıyla erişilebilir hale getirir. | OAuth tokens | +|

Passkeys

Passkey'lerle parolasız kimlik doğrulama desteği, kullanıcıların tüm cihazlarında biyometri veya güvenlik anahtarlarıyla güvenli bir şekilde giriş yapmasını sağlar. | OAuth tokens | +|

Kimliğe bürünme

Hata ayıklama ve destek için kullanıcıların kimliğine bürünün, onların hesabına sanki siz onlarmışsınız gibi giriş yapın. | Webhooks | +|

Webhooks

Kullanıcılar ürününüzü kullandığında bildirim alın, Svix üzerine inşa edilmiştir. | Webhooks | +|

Otomatik e-postalar

Kayıt, parola sıfırlama ve e-posta doğrulama gibi tetikleyicilerde özelleştirilebilir e-postalar gönderin, WYSIWYG editörüyle düzenlenebilir. | Email templates | +|

Kullanıcı oturumu ve JWT yönetimi

Stack Auth yenileme ve erişim tokenlarını, JWT'leri ve çerezleri yönetir, uygulama maliyeti olmadan en iyi performansı sağlar. | User button | +|

M2M kimlik doğrulama

Makinelerinizi diğer makinelere doğrulamak için kısa ömürlü erişim tokenları kullanın. | M2M authentication | + + +## 📦 Kurulum ve Ayarlar + +Stack Auth'u Next.js projenize kurmak için (React, JavaScript veya diğer çerçeveler için [eksiksiz dokümantasyonumuza](https://docs.stack-auth.com) bakın): + +1. Aşağıdaki komutla Stack Auth'un kurulum sihirbazını çalıştırın: + ```bash + npx @stackframe/stack-cli@latest init + ``` + +2. Ardından [Stack Auth kontrol panelinde](https://app.stack-auth.com/projects) bir hesap oluşturun, bir API anahtarıyla yeni bir proje oluşturun ve ortam değişkenlerini Next.js projenizin .env.local dosyasına kopyalayın: + ``` + NEXT_PUBLIC_STACK_PROJECT_ID= + NEXT_PUBLIC_STACK_PUBLISHABLE_CLIENT_KEY= + STACK_SECRET_SERVER_KEY= + ``` +3. Hepsi bu kadar! Uygulamanızı `npm run dev` ile çalıştırabilir ve kayıt sayfasını görmek için [http://localhost:3000/handler/signup](http://localhost:3000/handler/signup) adresine gidebilirsiniz. Ayrıca hesap ayarları sayfasını [http://localhost:3000/handler/account-settings](http://localhost:3000/handler/account-settings) adresinde kontrol edebilirsiniz. + +Daha ayrıntılı bir kılavuz için [dokümantasyona](https://docs.stack-auth.com/getting-started/setup) göz atın. + +## 🌱 Stack Auth ile oluşturulmuş bazı topluluk projeleri + +Kendinize ait bir projeniz mi var? Bir PR oluşturursanız veya [Discord](https://discord.stack-auth.com)'da bize mesaj atarsanız onu öne çıkarmaktan mutluluk duyarız. + +### Templates +- [Stack Auth Template by Stack Auth Team](https://github.com/stack-auth/stack-auth-template) +- [Next SaaSkit by wolfgunblood](https://github.com/wolfgunblood/nextjs-saaskit) +- [SaaS Boilerplate by Robin Faraj](https://github.com/robinfaraj/saas-boilerplate) + +### Examples +- [Stack Auth Example by career-tokens](https://github.com/career-tokens/StackYCAuth) +- [Stack Auth Demo by the Stack Auth team](https://github.com/stack-auth/stack-auth/tree/dev/examples/demo) +- [Stack Auth E-Commerce Example by the Stack Auth team](https://github.com/stack-auth/stack-auth/tree/dev/examples/e-commerce) + +## 🏗 Geliştirme ve Katkı + +Bu bölüm, Stack Auth projesine katkıda bulunmak veya Stack Auth kontrol panelini yerel olarak çalıştırmak isteyenler içindir. + +**Önemli**: Lütfen [katkı yönergelerini](CONTRIBUTING.md) dikkatlice okuyun ve yardım etmek istiyorsanız [Discord'umuza](https://discord.stack-auth.com) katılın. + +### Gereksinimler + +- Node v20 +- pnpm v9 +- Docker + +### Kurulum + +Not: Sorunsuz bir geliştirme deneyimi için 24 GB+ RAM önerilir. + +Yeni bir terminalde: + +```sh +pnpm install +pnpm build:packages +pnpm codegen +pnpm restart-deps +pnpm dev + +# Farklı bir terminalde, testleri izleme modunda çalıştırın +pnpm test +``` + +Artık geliştirici başlatma panelini [http://localhost:8100](http://localhost:8100) adresinde açabilirsiniz. Oradan kontrol paneline [http://localhost:8101](http://localhost:8101) adresinden, API'ye port 8102'den, demoya port 8103'ten, dokümantasyona port 8104'ten, Inbucket'a (e-postalar) port 8105'ten ve Prisma Studio'ya port 8106'dan erişebilirsiniz. Çalışan tüm hizmetlerin listesi için geliştirici başlatma paneline bakın. + +IDE'niz tüm `@stackframe/XYZ` içe aktarımlarında hata gösterebilir. Bunu düzeltmek için TypeScript dil sunucusunu yeniden başlatmanız yeterlidir; örneğin VSCode'da komut paletini (Ctrl+Shift+P) açıp `Developer: Reload Window` veya `TypeScript: Restart TS server` komutunu çalıştırabilirsiniz. + +Aşağıdaki kurulum için önceden doldurulmuş .env dosyaları mevcut olup paketlerin her birinde `.env.development` içinde varsayılan olarak kullanılır. Ancak bir üretim derlemesi oluşturuyorsanız (örn. `pnpm run build` ile), ortam değişkenlerini manuel olarak sağlamanız gerekir (aşağıya bakın). + +### Faydalı komutlar + +```sh +pnpm install +pnpm typecheck +pnpm lint +pnpm build +pnpm build:packages +pnpm codegen +pnpm dev +pnpm dev:full +pnpm dev:basic +pnpm start-deps +pnpm stop-deps +pnpm restart-deps +pnpm db:migration-gen +pnpm db:reset +pnpm db:init +pnpm db:seed +pnpm db:migrate +pnpm test +pnpm explain-query +pnpm verify-data-integrity +``` + +Not: Yapay zeka ile çalışırken, yapay zekanın sorgular çalıştırabilmesi için geliştirme sunucusunun açık olduğu bir terminal sekmesi tutmalısınız. + +## ❤ Katkıda Bulunanlar + + + + diff --git a/README.vi.md b/README.vi.md new file mode 100644 index 0000000000..bcf9f27f97 --- /dev/null +++ b/README.vi.md @@ -0,0 +1,158 @@ +> Bản dịch này được tạo bởi Claude. Nếu bạn có đề xuất cải thiện, PR luôn được chào đón. + +[![Stack Logo](/.github/assets/logo.png)](https://stack-auth.com) + +

+ 📘 Tài liệu + | ☁️ Phiên bản Cloud + | ✨ Demo + | 🎮 Discord +

+ +

+ English | 繁體中文 | 简体中文 | 日本語 | 한국어 | العربية | Bosanski | Dansk | Deutsch | Español | Français | Italiano | Norsk | Polski | Português (Brasil) | Русский | ไทย | Tiếng Việt | Türkçe | ភាសាខ្មែរ +

+ +# Stack Auth: Nền tảng xác thực mã nguồn mở + +Stack Auth là giải pháp xác thực người dùng được quản lý. Thân thiện với nhà phát triển và hoàn toàn mã nguồn mở (được cấp phép theo MIT và AGPL). + +Stack Auth giúp bạn bắt đầu chỉ trong năm phút, sau đó bạn có thể sử dụng tất cả các tính năng khi dự án phát triển. Dịch vụ quản lý của chúng tôi hoàn toàn tùy chọn và bạn có thể xuất dữ liệu người dùng và tự triển khai, miễn phí, bất cứ lúc nào. + +Chúng tôi hỗ trợ giao diện Next.js, React và JavaScript, cùng với bất kỳ backend nào có thể sử dụng [REST API](https://docs.stack-auth.com/api/overview) của chúng tôi. Xem [hướng dẫn cài đặt](https://docs.stack-auth.com/docs/next/getting-started/setup) để bắt đầu. + +
+Stack Auth Setup +
+ +## Khác biệt gì so với X? + +Hãy tự hỏi về `X`: + +- `X` có phải mã nguồn mở không? +- `X` có thân thiện với nhà phát triển, tài liệu đầy đủ, và cho phép bạn bắt đầu trong vài phút không? +- Ngoài xác thực, `X` có hỗ trợ phân quyền và quản lý người dùng không (xem danh sách tính năng bên dưới)? + +Nếu bạn trả lời "không" cho bất kỳ câu hỏi nào, đó chính là điểm khác biệt của Stack Auth so với `X`. + +## ✨ Tính năng + +Để nhận thông báo sớm nhất khi chúng tôi thêm tính năng mới, hãy đăng ký [bản tin của chúng tôi](https://stack-auth.beehiiv.com/subscribe). + +| | | +|-|:-:| +|

`` và ``

Các component xác thực hỗ trợ OAuth, đăng nhập bằng mật khẩu và magic link, với khóa phát triển dùng chung để cài đặt nhanh hơn. Tất cả component đều hỗ trợ chế độ tối/sáng. | Sign-in component | +|

API Next.js theo phong cách tự nhiên

Chúng tôi xây dựng trên server components, React hooks và route handlers. | ![Dark/light mode](.github/assets/components.png) | +|

Bảng điều khiển người dùng

Bảng điều khiển để lọc, phân tích và chỉnh sửa người dùng. Thay thế công cụ nội bộ đầu tiên mà bạn phải xây dựng. | ![User dashboard](.github/assets/dashboard.png) | +|

Cài đặt tài khoản

Cho phép người dùng cập nhật hồ sơ, xác minh email hoặc thay đổi mật khẩu. Không cần cài đặt gì thêm. | Account settings component | +|

Đa tổ chức & nhóm

Quản lý khách hàng B2B với cấu trúc tổ chức hợp lý và mở rộng được đến hàng triệu người dùng. | Selected team switcher component | +|

Kiểm soát truy cập theo vai trò

Định nghĩa đồ thị quyền hạn tùy ý và gán cho người dùng. Tổ chức có thể tạo vai trò riêng. | RBAC | +|

Kết nối OAuth

Ngoài đăng nhập, Stack Auth còn quản lý access token cho API bên thứ ba như Outlook và Google Calendar. Hệ thống xử lý việc làm mới token và kiểm soát phạm vi, giúp truy cập access token chỉ qua một lệnh gọi hàm duy nhất. | OAuth tokens | +|

Passkeys

Hỗ trợ xác thực không cần mật khẩu bằng passkeys, cho phép người dùng đăng nhập an toàn bằng sinh trắc học hoặc khóa bảo mật trên tất cả thiết bị. | OAuth tokens | +|

Mạo danh người dùng

Mạo danh người dùng để gỡ lỗi và hỗ trợ, đăng nhập vào tài khoản của họ như thể bạn là họ. | Webhooks | +|

Webhooks

Nhận thông báo khi người dùng sử dụng sản phẩm của bạn, được xây dựng trên Svix. | Webhooks | +|

Email tự động

Gửi email tùy chỉnh theo các sự kiện như đăng ký, đặt lại mật khẩu và xác minh email, có thể chỉnh sửa bằng trình soạn thảo WYSIWYG. | Email templates | +|

Quản lý phiên người dùng & JWT

Stack Auth quản lý refresh token, access token, JWT và cookie, mang lại hiệu suất tốt nhất mà không tốn chi phí triển khai. | User button | +|

Xác thực M2M

Sử dụng access token ngắn hạn để xác thực máy với máy. | M2M authentication | + + +## 📦 Cài đặt & Thiết lập + +Để cài đặt Stack Auth trong dự án Next.js của bạn (đối với React, JavaScript hoặc các framework khác, xem [tài liệu đầy đủ](https://docs.stack-auth.com)): + +1. Chạy trình hướng dẫn cài đặt của Stack Auth bằng lệnh sau: + ```bash + npx @stackframe/stack-cli@latest init + ``` + +2. Sau đó, tạo tài khoản trên [bảng điều khiển Stack Auth](https://app.stack-auth.com/projects), tạo dự án mới với API key, và sao chép các biến môi trường vào file .env.local của dự án Next.js: + ``` + NEXT_PUBLIC_STACK_PROJECT_ID= + NEXT_PUBLIC_STACK_PUBLISHABLE_CLIENT_KEY= + STACK_SECRET_SERVER_KEY= + ``` +3. Vậy là xong! Bạn có thể chạy ứng dụng với `npm run dev` và truy cập [http://localhost:3000/handler/signup](http://localhost:3000/handler/signup) để xem trang đăng ký. Bạn cũng có thể xem trang cài đặt tài khoản tại [http://localhost:3000/handler/account-settings](http://localhost:3000/handler/account-settings). + +Xem [tài liệu](https://docs.stack-auth.com/getting-started/setup) để biết hướng dẫn chi tiết hơn. + +## 🌱 Một số dự án cộng đồng được xây dựng với Stack Auth + +Bạn có dự án riêng? Chúng tôi rất vui được giới thiệu nếu bạn tạo PR hoặc nhắn cho chúng tôi trên [Discord](https://discord.stack-auth.com). + +### Templates +- [Stack Auth Template by Stack Auth Team](https://github.com/stack-auth/stack-auth-template) +- [Next SaaSkit by wolfgunblood](https://github.com/wolfgunblood/nextjs-saaskit) +- [SaaS Boilerplate by Robin Faraj](https://github.com/robinfaraj/saas-boilerplate) + +### Examples +- [Stack Auth Example by career-tokens](https://github.com/career-tokens/StackYCAuth) +- [Stack Auth Demo by the Stack Auth team](https://github.com/stack-auth/stack-auth/tree/dev/examples/demo) +- [Stack Auth E-Commerce Example by the Stack Auth team](https://github.com/stack-auth/stack-auth/tree/dev/examples/e-commerce) + +## 🏗 Phát triển & Đóng góp + +Phần này dành cho bạn nếu bạn muốn đóng góp cho dự án Stack Auth hoặc chạy bảng điều khiển Stack Auth trên máy cục bộ. + +**Quan trọng**: Vui lòng đọc [hướng dẫn đóng góp](CONTRIBUTING.md) cẩn thận và tham gia [Discord của chúng tôi](https://discord.stack-auth.com) nếu bạn muốn giúp đỡ. + +### Yêu cầu + +- Node v20 +- pnpm v9 +- Docker + +### Thiết lập + +Lưu ý: Khuyến nghị RAM 24GB trở lên để có trải nghiệm phát triển mượt mà. + +Trong terminal mới: + +```sh +pnpm install +pnpm build:packages +pnpm codegen +pnpm restart-deps +pnpm dev + +# Trong terminal khác, chạy test ở chế độ theo dõi +pnpm test +``` + +Bây giờ bạn có thể mở trang khởi động phát triển tại [http://localhost:8100](http://localhost:8100). Từ đó, bạn có thể truy cập bảng điều khiển tại [http://localhost:8101](http://localhost:8101), API trên cổng 8102, demo trên cổng 8103, tài liệu trên cổng 8104, Inbucket (email) trên cổng 8105, và Prisma Studio trên cổng 8106. Xem trang khởi động phát triển để biết danh sách tất cả các dịch vụ đang chạy. + +IDE của bạn có thể hiển thị lỗi trên tất cả import `@stackframe/XYZ`. Để khắc phục, chỉ cần khởi động lại TypeScript language server; ví dụ, trong VSCode bạn có thể mở command palette (Ctrl+Shift+P) và chạy `Developer: Reload Window` hoặc `TypeScript: Restart TS server`. + +Các file .env được điền sẵn cho cài đặt bên dưới có sẵn và được sử dụng mặc định trong `.env.development` ở mỗi package. Tuy nhiên, nếu bạn tạo bản build production (ví dụ với `pnpm run build`), bạn phải cung cấp các biến môi trường thủ công (xem bên dưới). + +### Các lệnh hữu ích + +```sh +pnpm install +pnpm typecheck +pnpm lint +pnpm build +pnpm build:packages +pnpm codegen +pnpm dev +pnpm dev:full +pnpm dev:basic +pnpm start-deps +pnpm stop-deps +pnpm restart-deps +pnpm db:migration-gen +pnpm db:reset +pnpm db:init +pnpm db:seed +pnpm db:migrate +pnpm test +pnpm explain-query +pnpm verify-data-integrity +``` + +Lưu ý: Khi làm việc với AI, bạn nên mở sẵn một tab terminal với dev server để AI có thể chạy truy vấn. + +## ❤ Người đóng góp + + + + diff --git a/README.zh-CN.md b/README.zh-CN.md index 8a8283f200..2652e1313f 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -10,7 +10,7 @@

- English | 繁體中文 | 简体中文 | 日本語 | 한국어 | Deutsch | Español | Français | Italiano | Português (Brasil) + English | 繁體中文 | 简体中文 | 日本語 | 한국어 | العربية | Bosanski | Dansk | Deutsch | Español | Français | Italiano | Norsk | Polski | Português (Brasil) | Русский | ไทย | Tiếng Việt | Türkçe | ភាសាខ្មែរ

# Stack Auth：开源身份验证平台 diff --git a/README.zh-TW.md b/README.zh-TW.md index b90feb05d9..18ce6a7417 100644 --- a/README.zh-TW.md +++ b/README.zh-TW.md @@ -10,7 +10,7 @@

- English | 繁體中文 | 简体中文 | 日本語 | 한국어 | Deutsch | Español | Français | Italiano | Português (Brasil) + English | 繁體中文 | 简体中文 | 日本語 | 한국어 | العربية | Bosanski | Dansk | Deutsch | Español | Français | Italiano | Norsk | Polski | Português (Brasil) | Русский | ไทย | Tiếng Việt | Türkçe | ភាសាខ្មែរ

# Stack Auth：開源身份驗證平台