Skip to content

Commit c7c44f7

Browse files
jkarthidjkarthid
authored
Merge pull request #2 from skilled-coderAI/develop
Pull Request: Integrate Helpmate-AI Chatbot with Enhanced User Experience
2 parents 32cad1f + 9e95a7c commit c7c44f7

File tree

2,573 files changed

+389706
-93
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

2,573 files changed

+389706
-93
lines changed

‎.env.example

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,5 @@ OLLAMA_BASE_URL=http://localhost:11434
1616
VECTOR_DB_PATH=./data/vector_db
1717

1818
# Default Models
19-
DEFAULT_OLLAMA_MODEL=llama2
19+
DEFAULT_OLLAMA_MODEL=llama3.2:1b
2020
DEFAULT_EMBEDDING_MODEL=sentence-transformers/all-MiniLM-L6-v2

‎.gitignore

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,26 @@ build/
3131
*.egg-info/
3232

3333
# Logs
34+
logs
3435
*.log
36+
npm-debug.log*
37+
yarn-debug.log*
38+
yarn-error.log*
39+
pnpm-debug.log*
40+
lerna-debug.log*
41+
42+
node_modules
43+
dist
44+
dist-ssr
45+
*.local
46+
47+
# Editor directories and files
48+
.vscode/*
49+
!.vscode/extensions.json
50+
.idea
51+
.DS_Store
52+
*.suo
53+
*.ntvs*
54+
*.njsproj
55+
*.sln
56+
*.sw?

‎CODE_OF_CONDUCT.md

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socioeconomic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
- Demonstrating empathy and kindness toward other people
21+
- Being respectful of differing opinions, viewpoints, and experiences
22+
- Giving and gracefully accepting constructive feedback
23+
- Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
- Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
- The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
- Trolling, insulting or derogatory comments, and personal or political attacks
33+
- Public or private harassment
34+
- Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
- Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
contact@coderai.co.
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

‎CONTRIBUTING.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Contributing to CoderAI
2+
3+
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.
4+
5+
To contribute to this project, please follow the [fork and pull request](https://docs.github.com/en/get-started/quickstart/contributing-to-projects) workflow.
6+
7+
## Reporting Bugs or Suggesting Improvements
8+
9+
Our [GitHub Issues](https://github.com/yourusername/coderAI/issues) page is where we track bugs, improvements, and feature requests. When creating an issue, please:
10+
11+
- **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.
12+
13+
- **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.
14+
15+
- **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.
16+
17+
## Development Setup
18+
19+
1. Fork the repository
20+
2. Clone your fork:
21+
```bash
22+
git clone https://github.com/yourusername/coderAI.git
23+
cd coderAI
24+
```
25+
3. Install dependencies:
26+
```bash
27+
pip install -r requirements.txt
28+
```
29+
4. Create a new branch for your feature:
30+
```bash
31+
git checkout -b feature-name
32+
```
33+
34+
## Code Style Guidelines
35+
36+
- Follow PEP 8 style guidelines for Python code
37+
- Use meaningful variable and function names
38+
- Add comments for complex logic
39+
- Write clear commit messages following conventional commits format
40+
- Include docstrings for functions and classes
41+
- Write tests for new features
42+
43+
## Opening a Pull Request
44+
45+
Before submitting a pull request:
46+
47+
1. Test your changes thoroughly
48+
2. Update documentation if needed
49+
3. Ensure all tests pass
50+
4. Rebase your branch on the latest main branch
51+
52+
When creating the pull request:
53+
54+
- Use a clear title following semantic commit conventions
55+
- Example: `feat: add new AI model integration`
56+
- Example: `fix: resolve issue with GitHub authentication`
57+
- Provide a detailed description of your changes
58+
- Link any related issues
59+
- Ensure CI checks pass
60+
61+
## Questions and Discussions
62+
63+
If you need help or want to discuss ideas:
64+
65+
- Open a [Discussion](https://github.com/yourusername/coderAI/discussions) for general questions
66+
- Join our community channels (if available)
67+
- Check existing issues and discussions before creating new ones
68+
69+
We aim to review all contributions promptly and provide constructive feedback. Thank you for helping improve CoderAI!

‎Helpmate-AI/.eslintrc.cjs

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
module.exports = {
2+
root: true,
3+
env: { browser: true, es2020: true },
4+
extends: [
5+
'eslint:recommended',
6+
'plugin:react/recommended',
7+
'plugin:react/jsx-runtime',
8+
'plugin:react-hooks/recommended',
9+
],
10+
ignorePatterns: ['dist', '.eslintrc.cjs'],
11+
parserOptions: { ecmaVersion: 'latest', sourceType: 'module' },
12+
settings: { react: { version: '18.2' } },
13+
plugins: ['react-refresh'],
14+
rules: {
15+
'react/jsx-no-target-blank': 'off',
16+
'react-refresh/only-export-components': [
17+
'warn',
18+
{ allowConstantExport: true },
19+
],
20+
},
21+
}

‎Helpmate-AI/.gitignore

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
pnpm-debug.log*
8+
lerna-debug.log*
9+
10+
.env
11+
node_modules
12+
dist
13+
dist-ssr
14+
*.local
15+
16+
# Editor directories and files
17+
.vscode/*
18+
!.vscode/extensions.json
19+
.idea
20+
.DS_Store
21+
*.suo
22+
*.ntvs*
23+
*.njsproj
24+
*.sln
25+
*.sw?

‎Helpmate-AI/README.md

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
<div align="center">
2+
3+
![GitHub repo size](https://img.shields.io/github/repo-size/codeaashu/Helpmate-AI)
4+
![GitHub stars](https://img.shields.io/github/stars/codeaashu/Helpmate-AI?style=social)
5+
![GitHub forks](https://img.shields.io/github/forks/codeaashu/Helpmate-AI?style=social)
6+
[![Twitter Follow](https://img.shields.io/twitter/follow/warrior_aashuu?style=social)](https://twitter.com/intent/follow?screen_name=warrior_aashuu)
7+
8+
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="2300">
9+
<h1 align="center">🤖 Introducing to Helpmate AI 🤖</h1>
10+
<img src="./public/Helpmate-AI.png" width="100px" />
11+
<br><a href="https://helpmate-ai.vercel.app/"><strong>HELPMATE AI</strong></a>
12+
<h4 align="center">✦ Let's take help with your AI mate! ✦</h4>
13+
<a href="https://ai.google.dev/competition/projects/helpmate-ai"><strong>Click here to vote our APP</strong></a></br>
14+
15+
16+
` Helpmate is a AI ChatBot web app where you can ask any question and you will get the answer. `
17+
<hr><img src="./public/Helpmate Mockup.png"/>
18+
19+
` Features 🌟 `
20+
</div>
21+
22+
```
23+
🤖 Conversational AI Interface
24+
📝 Text Summarization
25+
🧩 Question Answering
26+
📲 Responsive Layout
27+
🎨 Sleek Design
28+
📈 Scalability and Performance
29+
```
30+
<div align="center"><hr>
31+
32+
` Technologies Used 💻 `
33+
34+
![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>
35+
36+
<details>
37+
<summary>Instructions for Testing Helpmate AI</summary>
38+
<a href="#"><img src="./public/technologist.png" width="150"></a> <br>
39+
40+
## Step 1: Open the App
41+
Click on the provided link to access the app in your browser.
42+
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.
43+
Click the "Generate Answer" button to submit your question.
44+
45+
## Step 2: Receive Answer
46+
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.
47+
48+
## Step 3: Performance and Response Accuracy
49+
Assess the speed and accuracy of responses provided by the app
50+
51+
## Step 4: Testing Edge Cases and Scenarios
52+
### Scenario 1: Basic Questions
53+
Ask questions that require factual information, such as:
54+
What is the capital of France?
55+
Who is the president of the United States?
56+
What is the chemical symbol for gold?
57+
58+
### Scenario 2: Complex Questions
59+
Ask questions that require a more comprehensive understanding, such as:
60+
What are the ethical implications of artificial intelligence?
61+
How can I improve my writing skills?
62+
What is the best way to invest in cryptocurrency?
63+
64+
### Scenario 3: Conversational Questions
65+
Engage in a conversation with Helpmate AI by asking follow-on questions, providing additional information, or expressing your opinions.
66+
Example: Ask a question about the history of the internet.
67+
Follow up with a question about the impact of the internet on society.
68+
Share your thoughts on the future of the internet.
69+
70+
### Scenario 4: Versatility Across Domains
71+
Ask questions spanning different fields such as science, technology, history, and entertainment. Suggest specific cases to challenge the app’s capabilities.<br>
72+
73+
`Thank you for taking the time to test Helpmate AI.`
74+
</details><hr>
75+
76+
` © License ✔️ `
77+
78+
[![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)
79+
80+
This project is licensed under the NPM or MIT - see the [LICENSE](LICENSE) file for details. <hr>
81+
82+
` Getting Started 🚀 Setup Procedure ⚙️ `
83+
84+
To run this web application locally, first get google gemini API key from: [api-key](https://aistudio.google.com/app/apikey)<br>
85+
86+
`1. Clone this repository to your local machine` <br>
87+
`2. Open App.jsx and then open terminal` <br>
88+
`3. Now install npm` <br>
89+
`4. then type the command (npm run dev)` <hr>
90+
91+
`How can you contribute in this projects? 🫱🏻‍🫲🏼`
92+
93+
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.
94+
95+
`Don't forget to give star this repository ⭐`
96+
97+
98+
`👍🏻 All Set! 💌`
99+
100+
</div>

0 commit comments

Comments
 (0)