From dfd046ec362b21368068856e2fa92230971db08b Mon Sep 17 00:00:00 2001 From: Mohammad Kermani Date: Thu, 27 Mar 2025 09:01:40 +0000 Subject: [PATCH] chore: update README --- README.md | 59 +++++++------------------------------------------------ 1 file changed, 7 insertions(+), 52 deletions(-) diff --git a/README.md b/README.md index d55369c..aa16ba9 100644 --- a/README.md +++ b/README.md @@ -1,61 +1,16 @@ - - Next.js 14 and App Router-ready AI chatbot. -

Next.js AI Chatbot

- +# Pattern App -

- An Open-Source AI Chatbot Template Built With Next.js and the AI SDK by Vercel. -

+This repository holds all the app logic of Pattern, a decentralized agentic RAG network. -

- Features · - Model Providers · - Deploy Your Own · - Running locally -

-
+## Running Locally -## Features +To be able to use the app, you need to have a running [core service](https://github.com/pattern-tech/pattern-core). So, before continuing, make sure you have the service running. -- [Next.js](https://nextjs.org) App Router - - Advanced routing for seamless navigation and performance - - React Server Components (RSCs) and Server Actions for server-side rendering and increased performance -- [AI SDK](https://sdk.vercel.ai/docs) - - Unified API for generating text, structured objects, and tool calls with LLMs - - Hooks for building dynamic chat and generative user interfaces - - Supports OpenAI (default), Anthropic, Cohere, and other model providers -- [shadcn/ui](https://ui.shadcn.com) - - Styling with [Tailwind CSS](https://tailwindcss.com) - - Component primitives from [Radix UI](https://radix-ui.com) for accessibility and flexibility -- Data Persistence - - [Vercel Postgres powered by Neon](https://vercel.com/storage/postgres) for saving chat history and user data - - [Vercel Blob](https://vercel.com/storage/blob) for efficient file storage -- [NextAuth.js](https://github.com/nextauthjs/next-auth) - - Simple and secure authentication - -## Model Providers - -This template ships with OpenAI `gpt-4o` as the default. However, with the [AI SDK](https://sdk.vercel.ai/docs), you can switch LLM providers to [OpenAI](https://openai.com), [Anthropic](https://anthropic.com), [Cohere](https://cohere.com/), and [many more](https://sdk.vercel.ai/providers/ai-sdk-providers) with just a few lines of code. - -## Deploy Your Own - -You can deploy your own version of the Next.js AI Chatbot to Vercel with one click: - -[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fvercel%2Fai-chatbot&env=AUTH_SECRET,OPENAI_API_KEY&envDescription=Learn%20more%20about%20how%20to%20get%20the%20API%20Keys%20for%20the%20application&envLink=https%3A%2F%2Fgithub.com%2Fvercel%2Fai-chatbot%2Fblob%2Fmain%2F.env.example&demo-title=AI%20Chatbot&demo-description=An%20Open-Source%20AI%20Chatbot%20Template%20Built%20With%20Next.js%20and%20the%20AI%20SDK%20by%20Vercel.&demo-url=https%3A%2F%2Fchat.vercel.ai&stores=[{%22type%22:%22postgres%22},{%22type%22:%22blob%22}]) - -## Running locally - -You will need to use the environment variables [defined in `.env.example`](.env.example) to run Next.js AI Chatbot. It's recommended you use [Vercel Environment Variables](https://vercel.com/docs/projects/environment-variables) for this, but a `.env` file is all that is necessary. - -> Note: You should not commit your `.env` file or it will expose secrets that will allow others to control access to your various OpenAI and authentication provider accounts. - -1. Install Vercel CLI: `npm i -g vercel` -2. Link local instance with Vercel and GitHub accounts (creates `.vercel` directory): `vercel link` -3. Download your environment variables: `vercel env pull` +Having a running core service, first create a `.env` file based on the contents of `.env.example`. Then, run the following commands to start the app in development mode: ```bash -pnpm install +pnpm i pnpm dev ``` -Your app template should now be running on [localhost:3000](http://localhost:3000/). +You may also use other package managers of your choice.