diff --git a/README.md b/README.md index 37d05af..f97148d 100644 --- a/README.md +++ b/README.md @@ -1,52 +1,56 @@ -# Next.js example apps for Scalekit - -This repository contains Next.js example applications demonstrating how to integrate with ScaleKit services. - -## Available Examples - -### 1. Webhook Events - -This example demonstrates how to listen to webhook events from ScaleKit. It shows: - -- Setting up webhook endpoints in a Next.js application -- Processing user events from ScaleKit -- Validating webhook signatures for security -- Handling different event types - -**Key Features:** - -- Secure webhook handling -- Event processing and validation -- Integration with ScaleKit's event system +

+ + + + + +

+ +

+ Scalekit Next.js Example Apps +

+ +

+ Auth stack for AI apps ⚡ Human auth capabilities +

+ +

+ npm version + License: MIT + Documentation +

+ +

+ Production-ready Next.js applications demonstrating enterprise authentication patterns with Scalekit +

+ +## 🚀 Available Examples + +### 1. Webhook Events Handler +**Real-time event processing for enterprise workflows** + +- **Secure Webhook Endpoints**: Signature validation and payload verification +- **Event Processing Pipeline**: Handle user lifecycle, organization, and connection events +- **Next.js API Routes**: Serverless function patterns for webhook handling +- **Error Handling**: Comprehensive logging and retry mechanisms ### 2. Full Stack Authentication +**Complete enterprise authentication flow** -This example showcases the full stack authentication capabilities of ScaleKit, including: - -- Authentication (AuthN) implementation -- Hosted login box integration -- Secure session management -- User management functionality (coming soon) -- Logout implementation - -**Key Features:** +- **OAuth 2.0 Integration**: Authorization code flow with PKCE +- **Hosted Login Box**: Customizable authentication UI +- **Session Management**: Secure JWT handling with HTTP-only cookies +- **Route Protection**: Middleware-based authentication guards +- **User Context**: React hooks for authentication state -- Complete authentication flow -- Session handling -- Secure user identity management +### 3. AWS Cognito SSO Integration +**Enterprise SSO bridging with AWS Cognito** -### 3. AWS Cognito with Scalekit SSO Integration - -This example demonstrates how to implement Single Sign-On (SSO) for enterprise users by integrating AWS Cognito with Scalekit using the OpenID Connect (OIDC) protocol. - -**Key Features:** - -- AWS Cognito authentication -- Enterprise SSO via Scalekit integration -- Secure session management with Iron Session -- User profile information display -- Protected routes with middleware -- Responsive UI with Tailwind CSS +- **OIDC Protocol**: Seamless integration between Cognito and Scalekit +- **Enterprise Identity Providers**: SAML/OIDC federation support +- **Iron Session Security**: Encrypted session storage +- **Responsive Design**: Tailwind CSS with mobile-first approach +- **Protected Routes**: App Router compatible middleware ## Getting Started @@ -73,6 +77,24 @@ Each example requires specific environment variables. Check the `.env.example` f For assistance, please contact ScaleKit support or open an issue in this repository. +## Key Features Across All Examples + +- **Enterprise SSO**: SAML 2.0 and OIDC protocol support +- **User Management**: Organization user lifecycle management +- **Directory Sync**: SCIM 2.0 automated user provisioning +- **Admin Portal**: Embeddable interface for IT administrators +- **Webhook Events**: Real-time notifications for user and organization changes +- **Security**: JWT tokens, CSRF protection, and secure session management + +## Additional Resources + +- 📚 [Scalekit Documentation](https://docs.scalekit.com) +- 🔧 [API Reference](https://docs.scalekit.com/apis/) +- 🚀 [Full Stack Auth Quickstart](https://docs.scalekit.com/fsa/quickstart/) +- 🔗 [SSO Integration Guide](https://docs.scalekit.com/sso/quickstart/) +- 💬 [Community Examples](https://github.com/orgs/scalekit-developers/repositories) +- ⚡ [Next.js Example](https://github.com/scalekit-developers/scalekit-nextjs-demo) + ## Contributing We welcome contributions! Please feel free to submit a pull request with any improvements or additional examples. @@ -80,3 +102,9 @@ We welcome contributions! Please feel free to submit a pull request with any imp ## License This project is licensed under the MIT License - see the LICENSE file for details. + +--- + +

+ Made with ❤️ by Scalekit +