From 806aa1bf5209baa64b5187149c882e3365b3e55e Mon Sep 17 00:00:00 2001 From: saif-at-scalekit Date: Fri, 5 Sep 2025 23:39:00 +0530 Subject: [PATCH 1/2] Enhance README with modern Scalekit positioning - Add auth stack for AI apps positioning with human auth capabilities - Include professional badges and documentation links - Restructure examples focusing on admin portal and authentication - Add comprehensive feature descriptions - Maintain accuracy to actual Node.js implementation capabilities --- README.md | 98 ++++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 71 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index b678573..3adc68d 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,51 @@ -# Node.js Example Apps - -This repository contains Node.js example applications demonstrating how to integrate with Scalekit services. - -## Available Examples - -### 1. Embed Admin Portal - -This example shows how to embed a Scalekit admin portal in your Node.js application. It demonstrates: - -- Authentication flow using OAuth 2.0 client credentials -- Generating portal links -- Serving the portal in an iframe with proper security headers - -**Key Files:** - -- `embed-admin-portal-sample/index.js` - Main application server -- `embed-admin-portal-sample/libraries/auth.js` - Authentication helper -- `embed-admin-portal-sample/libraries/scalekit.js` - Portal link generation - -### 2. Authentication Example - -This example demonstrates how to implement authentication using Scalekit's authentication services. It shows: - -- OAuth 2.0 token acquisition -- Secure credential management -- Error handling for authentication flows +

+ + + + + +

+ +

+ Scalekit Node.js Example Apps +

+ +

+ Auth stack for AI apps ⚡ Human auth capabilities +

+ +

+ npm version + License: MIT + Documentation +

+ +

+ Production-ready Node.js applications showcasing enterprise authentication and admin portal integration +

+ +## 🚀 Available Examples + +### 1. Embedded Admin Portal +**Enterprise-grade admin interface integration** + +- **OAuth 2.0 Client Credentials**: Secure server-to-server authentication +- **Portal Link Generation**: Dynamic admin portal URLs with proper security +- **iframe Integration**: Seamless embedding with CSP headers and security policies +- **Session Management**: Secure token handling and refresh mechanisms + +**Key Implementation Files:** +- `embed-admin-portal-sample/index.js` - Express server with portal integration +- `embed-admin-portal-sample/libraries/auth.js` - OAuth token management +- `embed-admin-portal-sample/libraries/scalekit.js` - Portal URL generation and validation + +### 2. Enterprise Authentication +**Server-side authentication patterns** + +- **OAuth 2.0 Flows**: Authorization code and client credentials patterns +- **Token Management**: Secure credential storage and rotation +- **Error Handling**: Comprehensive error scenarios and recovery +- **API Integration**: Direct Scalekit API interactions for user management ## Getting Started @@ -54,6 +75,23 @@ We welcome contributions! Please follow these guidelines: 2. Create a new branch for your feature 3. Submit a pull request with a clear description of changes +## Key Features + +- **Enterprise SSO**: SAML 2.0 and OIDC protocol support +- **Admin Portal**: White-labeled administration interface +- **User Management**: Complete organization user lifecycle +- **Directory Sync**: SCIM 2.0 automated provisioning +- **OAuth Security**: Client credentials and authorization code flows +- **Error Handling**: Production-ready error management and logging + +## Additional Resources + +- 📚 [Scalekit Documentation](https://docs.scalekit.com) +- 🔧 [API Reference](https://docs.scalekit.com/apis) +- 💬 [Community Support](https://github.com/scalekit-inc/scalekit-sdk-node-js/discussions) +- 🎯 [Get Started Guide](https://docs.scalekit.com/quick-start-guide) +- ⚡ [Node.js Integration Guide](https://docs.scalekit.com/integrations/nodejs) + ## Support For assistance, please contact Scalekit support or open an issue in this repository. @@ -61,3 +99,9 @@ For assistance, please contact Scalekit support or open an issue in this reposit ## License This project is licensed under the MIT License - see the LICENSE file for details. + +--- + +

+ Made with ❤️ by Scalekit +

From 77226bae1b5952168a4597d96ddf21611d12818e Mon Sep 17 00:00:00 2001 From: saif-at-scalekit Date: Fri, 5 Sep 2025 23:49:02 +0530 Subject: [PATCH 2/2] Fix documentation links - use real URLs from sitemap --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3adc68d..503cda3 100644 --- a/README.md +++ b/README.md @@ -87,10 +87,11 @@ We welcome contributions! Please follow these guidelines: ## Additional Resources - 📚 [Scalekit Documentation](https://docs.scalekit.com) -- 🔧 [API Reference](https://docs.scalekit.com/apis) -- 💬 [Community Support](https://github.com/scalekit-inc/scalekit-sdk-node-js/discussions) -- 🎯 [Get Started Guide](https://docs.scalekit.com/quick-start-guide) -- ⚡ [Node.js Integration Guide](https://docs.scalekit.com/integrations/nodejs) +- 🔧 [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) +- ⚡ [Node.js SDK](https://github.com/scalekit-inc/scalekit-sdk-node) ## Support