Pull Request: Integrate Helpmate-AI Chatbot with Enhanced User Experience

.env.example

@@ -16,5 +16,5 @@ OLLAMA_BASE_URL=http://localhost:11434
 VECTOR_DB_PATH=./data/vector_db
 
 # Default Models
-DEFAULT_OLLAMA_MODEL=llama2
+DEFAULT_OLLAMA_MODEL=llama3.2:1b
 DEFAULT_EMBEDDING_MODEL=sentence-transformers/all-MiniLM-L6-v2

.gitignore

@@ -31,4 +31,26 @@ build/
 *.egg-info/
 
 # Logs
+logs
 *.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socioeconomic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+contact@coderai.co.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,69 @@
+# Contributing to CoderAI
+
+This guide is intended to help you get started contributing to CoderAI. As an open-source AI integration platform, we welcome contributions in the form of new features, improved infrastructure, better documentation, or bug fixes.
+
+To contribute to this project, please follow the [fork and pull request](https://docs.github.com/en/get-started/quickstart/contributing-to-projects) workflow.
+
+## Reporting Bugs or Suggesting Improvements
+
+Our [GitHub Issues](https://github.com/yourusername/coderAI/issues) page is where we track bugs, improvements, and feature requests. When creating an issue, please:
+
+- **Describe your issue thoroughly:** Provide as many details as possible about what's going wrong. _How_ is it failing? Is there an error message? "It doesn't work" isn't helpful for tracking down problems.
+
+- **Include relevant code:** Share the code that's causing the issue, but only include the relevant parts. This makes it easier for us to reproduce and fix the problem.
+
+- **Format long code blocks:** When sharing long blocks of code or logs, wrap them in `<details>` and `</details>` tags. This collapses the content making the issue easier to read.
+
+## Development Setup
+
+1. Fork the repository
+2. Clone your fork:
+   ```bash
+   git clone https://github.com/yourusername/coderAI.git
+   cd coderAI
+   ```
+3. Install dependencies:
+   ```bash
+   pip install -r requirements.txt
+   ```
+4. Create a new branch for your feature:
+   ```bash
+   git checkout -b feature-name
+   ```
+
+## Code Style Guidelines
+
+- Follow PEP 8 style guidelines for Python code
+- Use meaningful variable and function names
+- Add comments for complex logic
+- Write clear commit messages following conventional commits format
+- Include docstrings for functions and classes
+- Write tests for new features
+
+## Opening a Pull Request
+
+Before submitting a pull request:
+
+1. Test your changes thoroughly
+2. Update documentation if needed
+3. Ensure all tests pass
+4. Rebase your branch on the latest main branch
+
+When creating the pull request:
+
+- Use a clear title following semantic commit conventions
+  - Example: `feat: add new AI model integration`
+  - Example: `fix: resolve issue with GitHub authentication`
+- Provide a detailed description of your changes
+- Link any related issues
+- Ensure CI checks pass
+
+## Questions and Discussions
+
+If you need help or want to discuss ideas:
+
+- Open a [Discussion](https://github.com/yourusername/coderAI/discussions) for general questions
+- Join our community channels (if available)
+- Check existing issues and discussions before creating new ones
+
+We aim to review all contributions promptly and provide constructive feedback. Thank you for helping improve CoderAI!

Helpmate-AI/.eslintrc.cjs

@@ -0,0 +1,21 @@
+module.exports = {
+  root: true,
+  env: { browser: true, es2020: true },
+  extends: [
+    'eslint:recommended',
+    'plugin:react/recommended',
+    'plugin:react/jsx-runtime',
+    'plugin:react-hooks/recommended',
+  ],
+  ignorePatterns: ['dist', '.eslintrc.cjs'],
+  parserOptions: { ecmaVersion: 'latest', sourceType: 'module' },
+  settings: { react: { version: '18.2' } },
+  plugins: ['react-refresh'],
+  rules: {
+    'react/jsx-no-target-blank': 'off',
+    'react-refresh/only-export-components': [
+      'warn',
+      { allowConstantExport: true },
+    ],
+  },
+}

Helpmate-AI/.gitignore

@@ -0,0 +1,25 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+.env
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?

Helpmate-AI/README.md

@@ -0,0 +1,100 @@
+<div align="center">                                                                                                
+
+  ![GitHub repo size](https://img.shields.io/github/repo-size/codeaashu/Helpmate-AI)
+  ![GitHub stars](https://img.shields.io/github/stars/codeaashu/Helpmate-AI?style=social) 
+  ![GitHub forks](https://img.shields.io/github/forks/codeaashu/Helpmate-AI?style=social)
+[![Twitter Follow](https://img.shields.io/twitter/follow/warrior_aashuu?style=social)](https://twitter.com/intent/follow?screen_name=warrior_aashuu)
+
+<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="2300">
+  <h1 align="center">🤖 Introducing to Helpmate AI 🤖</h1>
+  <img src="./public/Helpmate-AI.png" width="100px" />
+  <br><a href="https://helpmate-ai.vercel.app/"><strong>HELPMATE   AI</strong></a>
+  <h4 align="center">✦ Let's take help with your AI mate! ✦</h4>
+  <a href="https://ai.google.dev/competition/projects/helpmate-ai"><strong>Click here to vote our APP</strong></a></br>
+
+
+  ` Helpmate is a AI ChatBot web app where you can ask any question and you will get the answer. `
+<hr><img src="./public/Helpmate Mockup.png"/>
+
+  ` Features 🌟 `
+</div>
+
+```
+  🤖 Conversational AI Interface
+  📝 Text Summarization
+  🧩 Question Answering
+  📲 Responsive Layout
+  🎨 Sleek Design
+  📈 Scalability and Performance
+```
+<div align="center"><hr>
+
+` Technologies Used 💻 `
+
+![React](https://img.shields.io/badge/react-%2320232a.svg?style=plastic&logo=react&logoColor=%2361DAFB) ![TailwindCSS](https://img.shields.io/badge/tailwindcss-%2338B2AC.svg?style=plastic&logo=tailwind-css&logoColor=white) ![NPM](https://img.shields.io/badge/NPM-%23CB3837.svg?style=plastic&logo=npm&logoColor=white) ![React Query](https://img.shields.io/badge/-React%20Query-FF4154?style=plastic&logo=react%20query&logoColor=white) ![Vite](https://img.shields.io/badge/vite-%23646CFF.svg?style=plastic&logo=vite&logoColor=white) ![Vercel](https://img.shields.io/badge/vercel-%23000000.svg?style=plastic&logo=vercel&logoColor=white) ![Netlify](https://img.shields.io/badge/netlify-%23000000.svg?style=plastic&logo=netlify&logoColor=#00C7B7) ![Git](https://img.shields.io/badge/git-%23F05033.svg?style=plastic&logo=git&logoColor=white) ![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=plastic&logo=github&logoColor=white) ![GitHub Actions](https://img.shields.io/badge/github%20actions-%232671E5.svg?style=plastic&logo=githubactions&logoColor=white) ![Postman](https://img.shields.io/badge/Postman-FF6C37?style=plastic&logo=postman&logoColor=white) <br>
+
+ <details>
+    <summary>Instructions for Testing Helpmate AI</summary>
+    <a href="#"><img src="./public/technologist.png" width="150"></a> <br>
+
+## Step 1: Open the App
+Click on the provided link to access the app in your browser.
+User Interface: You'll be welcomed by a clean, minimalistic interface designed for ease of use. In the text box provided, type in any question you want to ask Helpmate AI.
+Click the "Generate Answer" button to submit your question.
+
+## Step 2: Receive Answer
+Helpmate AI will process your question using Google Gemini API and provide you with a comprehensive answer. The answer will be displayed as text in the response section.
+
+## Step 3: Performance and Response Accuracy
+Assess the speed and accuracy of responses provided by the app
+
+## Step 4: Testing Edge Cases and Scenarios
+### Scenario 1: Basic Questions
+Ask questions that require factual information, such as:
+What is the capital of France?
+Who is the president of the United States?
+What is the chemical symbol for gold?
+
+### Scenario 2: Complex Questions
+Ask questions that require a more comprehensive understanding, such as:
+What are the ethical implications of artificial intelligence?
+How can I improve my writing skills?
+What is the best way to invest in cryptocurrency?
+
+### Scenario 3: Conversational Questions
+Engage in a conversation with Helpmate AI by asking follow-on questions, providing additional information, or expressing your opinions.
+Example: Ask a question about the history of the internet.
+Follow up with a question about the impact of the internet on society.
+Share your thoughts on the future of the internet.
+
+### Scenario 4: Versatility Across Domains
+Ask questions spanning different fields such as science, technology, history, and entertainment. Suggest specific cases to challenge the app’s capabilities.<br>
+
+`Thank you for taking the time to test Helpmate AI.`
+</details><hr>
+
+` © License ✔️ `
+
+[![npm version](https://img.shields.io/npm/v/badge-maker.svg)](https://npmjs.org/package/badge-maker) [![npm license](https://img.shields.io/npm/l/badge-maker.svg)](https://npmjs.org/package/badge-maker) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+This project is licensed under the NPM or MIT - see the [LICENSE](LICENSE) file for details. <hr>
+
+` Getting Started 🚀 Setup Procedure ⚙️ `
+
+To run this web application locally, first get google gemini API key from: [api-key](https://aistudio.google.com/app/apikey)<br>
+
+`1. Clone this repository to your local machine` <br>
+`2. Open App.jsx and then open terminal` <br>
+`3. Now install npm` <br>
+`4. then type the command (npm run dev)` <hr>
+
+`How can you contribute in this projects? 🫱🏻‍🫲🏼`
+
+If you have a good knowledge in Tailwind CSS or React JS and want to contribute in this project just forked this repository and the improve the 𝐔𝐈 of Helpmate and then feel free to open an issue or submit a pull request. I reviewed your changes update and then merge your pull request. Please make sure to follow the existing code style and guidelines.
+
+`Don't forget to give star this repository ⭐`
+
+
+`👍🏻 All Set! 💌`
+
+</div>