Merge pull request #8 from FranciZhong/model-config

Model config

README.md

@@ -1,36 +1,95 @@
-This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+# Chatemo
 
-## Getting Started
+## 🚀 Introduction
 
-First, run the development server:
+[Chatemo](http://www.chatemo.chat/) is an innovative team communication app that seamlessly integrates Large Language Models (LLMs) to solve problems in real time. In Chatemo, you don't need to switch contexts to ask questions. Instead, various models and agents (with tailored prompts) are available directly in the conversation window. Simply provide the API keys from your preferred providers to get started.
 
-```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
-```
+### 🌟 Core Features
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+1. **AI-Enhanced Team Discussions**  
+   Effortlessly call on AI assistance at any point in your conversations, ensuring valuable insights and information are always at your fingertips.
 
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+2. **Multi-Model Flexibility**  
+   Support for multiple LLMs within the same communication context allows users to manage their own API keys and utilize preferred models based on specific needs.
 
-This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
+3. **Customizable AI Agents**  
+   Easily configure and manage AI agents tailored to your requirements. These agents can be utilized with any model across all communications and channels.
 
-## Learn More
+4. **Collaborative AI Ecosystem**  
+   Various AI agents work together, each specializing in different tasks, allowing teams to tackle complex, multi-faceted problems effectively.
 
-To learn more about Next.js, take a look at the following resources:
+5. **Context-Aware AI Interactions**  
+   Experience two types of AI behaviors: direct communication for focused, immediate responses, and channel mode, where AI agents consider message history for nuanced, context-aware assistance.
 
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+6. **Preview and Fine-Tune**  
+   Use Chatemo's preview mode to fine-tune AI responses for agent configurations and chat contexts before deployment, ensuring optimal alignment with team expectations.
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+## 🛠️ Tech Stack
 
-## Deploy on Vercel
+### 🖥️ Frontend
 
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+- ⚛️ **React**: JavaScript library for building user interfaces.
+- 🔼 **Next.js**: Framework for server-side rendering and static site generation.
+- 🎨 **Tailwind CSS**: Utility-first CSS framework.
+  - 🌓 **Tailwind Themes**: Customizable themes for styling.
+  - 🔀 **Tailwind Merge**: Utility for merging Tailwind CSS classes.
+- 🧱 **Shadcn UI**: Accessible component library for UI development.
+- 📝 **react-hook-form**: Library for managing form state.
+- 🗃️ **Zustand**: Lightweight state management solution.
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
+### 🗄️ Backend
+
+- 🔼 **Next.js API Routes**: For building API endpoints.
+- 🔌 **Socket.io**: For real-time communication.
+- 🔐 **NextAuth.js**: Authentication solution.
+  - 🔑 **Google OAuth**: For Google sign-in.
+- 🐘 **PostgreSQL**: Advanced relational database.
+- 🔗 **Prisma ORM**: For database management.
+
+### 🤖 AI Integration
+
+- 🤖 **OpenAI SDK**: Integration for OpenAI models.
+- 🤯 **Anthropic SDK**: Access to Anthropic's AI offerings.
+- 🧠 **Google AI SDK**: Tools for leveraging Google’s AI models.
+
+### 🛠️ Utilities
+
+- ✅ **Zod**: Type-safe schema validation.
+- 🔄 **Axios**: Promise-based HTTP client.
+- 📅 **date-fns**: Modern date utility library.
+- 🆔 **uuid**: For generating unique identifiers.
+- ⏳ **use-debounce**: React hook for debouncing.
+
+### 📝 Markdown Processing
+
+- 📘 **React Markdown**: Markdown component for React applications.
+- 🔧 **remark & rehype plugins**: Ecosystem for processing markdown and HTML.
+
+### 🧰 Development Tools
+
+- 📘 **TypeScript**: Typed superset of JavaScript.
+- 🧹 **ESLint**: Linter for identifying code issues.
+- 📦 **Prisma CLI**: Command-line interface for Prisma.
+- 🔐 **dotenv-cli**: Tool for loading environment variables.
+
+## 🚀 DevOps
+
+### 🔄 CI/CD
+
+- 🐙 **GitHub Actions**: CI/CD pipelines, ensuring seamless integration and deployment.
+
+### 🐳 Containerization
+
+- 📄 **Dockerfile**: Defines the environment for the application.
+- 🔧 **Docker Compose**: For setting up local development environments easily.
+
+### ☸️ Orchestration
+
+- 🚢 **Kubernetes (K8s)**: For managing containerized applications in production.
+
+### ☁️ Cloud Platforms
+
+- 🌐 **Google Cloud Platform (GCP)**
+  - 🛳️ **Google Kubernetes Engine (GKE)**: Managed Kubernetes service.
+- ☁️ **Amazon Web Services (AWS)**
+  - 🪣 **S3 Buckets**: Object storage service for files.