Welcome to the DocsGPT: ChatGPT for your Docs

This is a sample consumer app built by Descope to showcase the Descope Flows functionality with NextJS.

One-click Deploy

You can deploy this template to Vercel with the button below:

Technology Stack and Capabilities

Core Framework

• Next.js: A React framework designed for building high-performance applications with an exceptional developer experience.

Deployment Platforms

• Vercel: Provides a seamless way to preview and deploy changes directly from git repositories.

User Interface (UI)

• Tailwind CSS: A utility-first CSS framework that accelerates the process of UI development.
• Lucide: Offers a collection of simple and precise icons for web projects.
• next/font: Enables custom font optimization, eliminating the need for external network requests, thereby boosting performance.

React Hooks and Utility Functions

• useIntersectionObserver: A React hook to detect when an element becomes visible or hidden in the viewport.
• useLocalStorage: Enables the persistent storage of data within the browser's local storage.
• useScroll: A React hook to monitor scroll events and positions within an application.
• nFormatter: Simplifies the display of numbers by adding suffixes (e.g., 1.2k for 1200).
• capitalize: A utility function to capitalize the first letter of a string for improved readability.
• truncate: Allows for the shortening of strings to a specific length, useful for creating concise text previews.
• use-debounce: Debounces function calls or state updates, helping to optimize performance and reduce unnecessary processing.

Authentication & Language

• TypeScript: A static type-checking tool offering end-to-end type safety for robust development.
• Descope: Use no-code workflows to easily add authentication, authorization, and identity management to any customer-facing app.

Set up

In order to launch this app:

1. Clone the repo

git clone [email protected]:descope-sample-apps/nextjs-demo-app-router.git

2. Set up environment variables in .env file

DESCOPE_PROJECT_ID="YOUR PROJECT ID" // Required for Descope authentication
OPENAI_ASSISTANT_ID="YOUR OPENAI ASSISTANT ID" // With vector store attached
OPENAI_API_KEY="YOUR OPENAI API KEY"

You can get your project-id here.

You can create an OpenAI Assistant here and Vector Store here.

You can get your OpenAI API Key here.

3. Install dependencies

npm i

4. Start the app

Run this command to start the app:

npm run dev

5. Open the app

Open http://localhost:3000 with your browser to see the result.

6. Crawl Documentation

Log in to DocsGPT. Then, add the admin role to your user in the Descope console. This involves creating the role here and then adding it to your user here. Finally, click the profile widget in the top right of DocsGPT and click the Crawl Docs button.

Note that your OpenAI Asstant must have an instruction that tells it to use File Search. It could be something like this: You are Descope Assistant, a helpful product support assistant. Use you knowledge base to answer questions about audited financial statements.