update: README.md description

README.md

@@ -1,13 +1,50 @@
-# NeuraChatAi
+# NeuraChat - AI Chat
 
-Description soon
+## Introduction
+
+NeuraChatAi is an AI-powered chat application that offers customizable chat experiences. With NeuraChat, you can harness the power of OpenAI's language models to create intelligent conversations tailored to your needs.
+
+## Features:
+- **Working AI Chat:** Real-time conversations powered by advanced language models.
+- **OpenAI Integration:** Utilize GPT-3.5 and GPT-4 for enhanced chat capabilities.
+- **Responsive Design:** Enjoy smooth interactions across devices.
+- **Customizable Models:** Choose from a selection of models with unique performance.
+- **Dynamic Settings:** Adjust temperature, frequency penalty, max tokens, and top-p for tailored responses.
+- **Actions Counter:** Track API request usage for the current model.
+- **Light/Dark Mode:** Enjoy adaptive color themes for a personalized experience.
+- **Snackbar Alerts:** Receive informative messages and alerts.
+- **Auto-scroll:** Automatically move to the latest message for smooth chatting.
+- **Tip Suggestions:** Access conversation starters with ease.
+
+## Technologies
 
 * React
-* React Router
 * OpenAI API 4.24.7
-* Sass
 * Joy UI
+* React Router
 * Lodash
 * Material Icons
 * Day.js
-* JS
+* Sass
+* JS
+
+## Installation
+
+To run NeuraChat locally, follow these steps:
+
+1. Clone this repository.
+2. Navigate to the project directory.
+3. Install dependencies using `npm install` or `yarn install`.
+4. Start the development server with `npm run dev` or `yarn dev`. You can use `npm run host` or `yarn host` to take a look on your phone.
+5. Open your browser and visit `http://localhost:5173` (port may be different) to view the application.
+
+## Usage
+
+Once the application is running, you can:
+
+- Customize AI settings in the sidebar.
+- Engage in conversations in the chat interface.
+- Receive AI-generated responses based on your inputs.
+- Explore tip suggestions for conversation starters.
+
+Feel free to reach out if you have any questions, feedback, or suggestions. Happy chatting with NeuraChatAi!

src/components/Chat.jsx

@@ -59,15 +59,15 @@ function Chat() {
     }, [messages])
 
     const handleSend = () => {
-        DecreaseAvailableActions()
         setMessages((prevMessages) => [
             ...prevMessages,
             {isHuman: true, content: input, timestamp: dayjs().calendar().toString(),}
         ]);
         setInput("")
+        DecreaseAvailableActions()
         SendMessage(input, (errorMessage) => {
             setMessageSnackbar(errorMessage);
-        }, IncreaseAvailableActions).then(async (response) => {
+        }).then(async (response) => {
             IncreaseAvailableActions()
             setOutput(response)
         }).catch((error) => {
@@ -76,8 +76,7 @@ function Chat() {
         })
     }
 
-    const handleTip = async (tip) => {
-        DecreaseAvailableActions()
+    const handleTip = (tip) => {
         setMessages(prevMessages => [
             ...prevMessages,
             {
@@ -87,9 +86,10 @@ function Chat() {
             }
         ]);
         setInput("")
-        await SendMessage(tip, (errorMessage) => {
+        DecreaseAvailableActions()
+        SendMessage(tip, (errorMessage) => {
             setMessageSnackbar(errorMessage);
-        }, DecreaseAvailableActions).then(async (response) => {
+        }).then(async (response) => {
             IncreaseAvailableActions()
             setOutput(response)
         }).catch((error) => {

src/contexts/ActionsContext.jsx

@@ -15,12 +15,12 @@ const ActionsProvider = ({children}) => {
         if (availableActions < 3) {
             setTimeout(() => {
                 setAvailableActions((prevActions) => prevActions + 1)
-            }, 20000)
+            }, 8000)
         }
     }
 
     const IncreaseImmediatelyAvailableActions = () => {
-        if (availableActions < 3) {
+        if (availableActions <= 3) {
             setAvailableActions((prevActions) => prevActions + 1);
         }
     }