From e91dad739c04461726a4fd96b4bd21351f32724a Mon Sep 17 00:00:00 2001 From: Abhishek Mallick Date: Thu, 26 Sep 2024 17:44:09 +0530 Subject: [PATCH] fix: Updating workflow config Co-authored-by: Deepraj Bera --- .github/CODE_OF_CONDUCT.md | 74 +++++++++++++++++++ .github/CONTRIBUTING.md | 90 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 35 +++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 42 +++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 25 +++++++ CONTRIBUTION.md | 41 ----------- INSTALLATION.md | 62 ---------------- LICENSE | 21 ------ README.md | 85 +++++++++++++++++---- 9 files changed, 335 insertions(+), 140 deletions(-) create mode 100644 .github/CODE_OF_CONDUCT.md create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 CONTRIBUTION.md delete mode 100644 INSTALLATION.md delete mode 100644 LICENSE diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..6739b38 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,74 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +- The use of sexualized language or imagery and unwelcome sexual attention or + advances +- Trolling, insulting/derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or electronic + address, without explicit permission +- Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers 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, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at deepraj21.bera@gmail.com. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq \ No newline at end of file diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..d9deb4f --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,90 @@ +# ✨ Contributing Guide + +First off, thank you for considering contributing to DevHub! We appreciate your time and effort in helping make this project better. + +The following is a set of guidelines for contributing to DevHub. These are just guidelines, not rules, so use your best judgment and feel free to propose changes to this document in a pull request. + +## Table of Contents +- [What can I contribute?](#what-can-i-contribute) +- [Before You Contribute](#before-you-contribute) +- [Your First Contribution](#your-first-contribution) +- [Development Workflow](#development-workflow) + - [Cloning the Repository](#cloning-the-repository) + - [Creating a New Branch](#creating-a-new-branch) + - [Making Changes](#making-changes) + - [Submitting a Pull Request](#submitting-a-pull-request) +- [Reporting Bugs](#reporting-bugs) + - [How Do I Submit A Good Bug Report?](#how-do-i-submit-a-good-bug-report) +- [Contribution Guidelines](#contribution-guidelines) + - [Core Work Contributions](#core-work-contributions) + - [Template Contributions](#template-contributions) +- [Code of Conduct](#code-of-conduct) +- [License](#license) + +## What can I contribute? +There are several ways to contribute to this repository: + +1. **Feature Development**: Enhancing the feature functionalities of DevHub, including features related to matchmaking and user interaction. +3. **Bug Fixes**: Identifying and resolving bugs that affect the platform's performance or user experience. + +## Before You Contribute +Before starting to contribute, please make sure to: +- **Open an issue** on GitHub or discuss your idea on our [Discord](https://discord.gg/he8QHEC8WP) to get feedback and align with the project's goals. +- Review the [**Code of Conduct**](https://github.com/devhub-ai/devhub/blob/main/.github/CODE_OF_CONDUCT.md) and agree to abide by it. + +## Your First Contribution +If you're unsure where to begin contributing, you can start by looking through the **good first issues** or **help wanted issues**. These issues are great starting points for new contributors. + +## Development Workflow + +### Cloning the Repository +1. Fork the repository on GitHub. +2. Clone your forked repository to your local machine. +3. Navigate to the project directory in your terminal. + +### Creating a New Branch +1. Create a new branch from the `main` branch using `git checkout -b your-branch-name`. +2. Choose a descriptive name for your branch, such as `feat/add-new-feature` or `fix/bug-in-matchmaking`. + +### Making Changes +1. Make your changes to the codebase. +2. Ensure your changes follow the project's coding style and conventions. +3. Add or update tests if necessary. + +### Submitting a Pull Request +1. Push your branch to your forked repository. +2. Open a pull request from your branch to the `main` branch of the original repository. +3. Fill out the pull request template with relevant information and also mention any issues it resolves (if applicable). +4. Reference any related issues in the pull request description. +5. Wait for maintainers to review your pull request. + +## Reporting Bugs + +This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports. + +Before creating a new issue, **perform a cursory search** to see if the report exists. If it does, go through the discussion thread and leave a comment instead of opening a new one. + +If you find a **Closed** issue that is similar to what you are experiencing, open a new issue and include a link to the original case in your new one. + +If you cannot find an open or closed issue addressing the problem, **open a new issue**. + +Be sure to include: +- A **clear title and description** +- Relevant information +- A **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring. + +## Contribution Guidelines + + +1. **Feature Development**: Enhancing the feature functionalities of DevHub, including features related to matchmaking and user interaction. +3. **Bug Fixes**: Identifying and resolving bugs that affect the platform's performance or user experience. + +Every template contribution should: +- Include proper documentation that provides an overview of its functionality. +- Contribute relevant examples or templates that enhance user experience. + +## Code of Conduct +By participating in this project, you agree to abide by our [Code of Conduct](https://github.com/devhub-ai/devhub/blob/main/.github/CODE_OF_CONDUCT.md). + +## License +DevHub is licensed under the [Apache License 2.0](https://github.com/devhub-ai/devhub/blob/main/LICENSE). \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..6ea9a48 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,35 @@ +--- +name: "🐛 Bug Report" +about: Report a reproducible bug or regression. +title: '' +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Viable Solution** +If you have a potential solution in mind, please describe it here. + +**Additional context** +Add any other context about the problem here. + +**Checklist** +- [ ] I have searched for similar issues and couldn't find a resolution. +- [ ] I am willing to work on this issue and submit a pull request. +- [ ] This bug is specific to my OS environment (if yes, please specify above). diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..cae8be9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,42 @@ +--- + +name: "✨ Feature Request" +about: Suggest an amazing new idea for this project +title: 'Feature: [Concise Description of the Feature]' +labels: enhancement +assignees: '' + +--- + +## Feature Request + +**Is your feature request related to a problem you're trying to solve with Devhub? Please describe.** + + +**Describe the solution you'd like** + + +**Describe alternatives you've considered** + + +**How would this feature improve Devhub?** + + +**Additional context** + + +## Are you willing to resolve this issue by submitting a Pull Request? + + + +- [ ] Yes, I have the time and skills to work on this feature. +- [ ] Yes, I have the time, but I would need guidance on how to implement it. +- [ ] No, I don't have the time, although I believe I could do it if I had the time... +- [ ] No, I don't have the time and I wouldn't even know how to start. + + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..ee5f880 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,25 @@ +## Description +Please provide a summary of the changes made in this pull request. Include any relevant motivation and context for the changes. + +Fixes # (issue) + +## Type of Change +Please delete options that are not relevant. +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) + +## How Has This Been Tested? +Manual Testing / Jest Test's + +## Checklist +- [ ] My code follows the style guidelines of this project. +- [ ] I have performed a self-review of my code. +- [ ] I have commented my code, particularly in hard-to-understand areas. +- [ ] I have made corresponding changes to the documentation. +- [ ] My changes generate no new warnings. +- [ ] I have added tests that prove my fix is effective or that my feature works. +- [ ] New and existing unit tests pass locally with my changes. + +## Additional Notes +Add any other context or information that may be helpful for the reviewers. \ No newline at end of file diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md deleted file mode 100644 index 79e61c0..0000000 --- a/CONTRIBUTION.md +++ /dev/null @@ -1,41 +0,0 @@ - -# CONTRIBUTION GUIDE - -To contribute to this GitHub project, you can follow these steps: - -1. Fork the repository (https://github.com/devhub-ai/devhub) into your account. - -2. Make a new branch with `` - -3. Clone the repository from your account. - ```bash - git clone https://github.com//devhub - ``` - -4. Go to [INSTALLAtION GUIDE](INSTALLATION.md) to Install and run the project locally. - -5. After solving the problem (issue) or Updating the CodeBase commit the code and push it to a new branch with your desired branch name(eg. UI_Fix, Refactor etc). - ```bash - ## Add the Changes - git add . - - ## Commit with some useful message - git commit -m "" - - ## Push the Commit code - git push origin - ``` -6. Go to the GitHub website and navigate to your forked repository. - -7. Click the "New pull request" button. - -8. Select the branch you just pushed to and the branch you want to merge into on the original repository. - ![alt text](docs/images/image.png) - -9. Add a description of your changes and click the "Create pull request" button. - -10. Wait for the project maintainer to review your changes and provide feedback. - -11. Make any necessary changes based on feedback until your changes are accepted and merged into the main project. - -That's it you made it 🐣⭐⭐ \ No newline at end of file diff --git a/INSTALLATION.md b/INSTALLATION.md deleted file mode 100644 index 6e84ce4..0000000 --- a/INSTALLATION.md +++ /dev/null @@ -1,62 +0,0 @@ -# INSTALLATION GUIDE - -### Folder Structure - -``` -devhub/ -├── client/ -│ ├── node_modules/ -│ ├── public/ -│ ├── src/ -│ │ ├── assets/ -│ │ ├── components/ -│ │ ├── App.tsx -│ │ ├── main.tsx -│ │ └── vite-env.d.ts -│ ├── index.html -│ ├── package.json -│ ├── tsconfig.json -│ ├── vite.config.ts -│ └── package-lock.json -├── docs/ -├── server/ -│ ├── api/ -│ ├── app.py -│ ├── config.py -│ ├── extension.py -│ ├── models.py -│ ├── requirements.txt -│ └── server.py -``` - -Enter into the root directory. -```bash -cd devhub -``` -Open two terminal for server and client and enter into the directories. -```bash -## 1st terminal for server -cd server - -## Create Virtual Environment -python -m venv venv - -## Activate the virtual Env. -./venv/Scripts/activate - -## Intall dependencies -pip install -r requirements.txt - -## Run the Server -flask run or python server.py -``` -```bash -## 2nd terminal for client -cd client - -## Intall dependencies -npm install - -## Run the client -npm run dev -``` \ No newline at end of file diff --git a/LICENSE b/LICENSE deleted file mode 100644 index dea227b..0000000 --- a/LICENSE +++ /dev/null @@ -1,21 +0,0 @@ -MIT License - -Copyright (c) [2024] [Deepraj Bera] - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index d07b0c7..d7c5c6b 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,81 @@ -# Devhub +# DevHub: Intelligent Matchmaking Platform for Developers 💻🤝 -A Platform to connect with like minded people and create peer group using AI chat with advance algorithm and LLM. +DevHub is an innovative platform designed to connect developers who share similar interests and complementary skills. By leveraging advanced technologies, it facilitates intelligent matchmaking and personalized recommendations, enabling devs to form effective teams and engage in meaningful collaborations. The platform provides a structured and user-friendly environment for networking, learning, and growth, ultimately enhancing the academic and professional experiences of developers. -Students from colleges and universities often face significant challenges when it comes to finding peers with similar interests, skills, and knowledge for collaboration on projects, hackathons, and other academic or extracurricular activities. This difficulty in connecting with like-minded individuals can hinder their ability to form effective teams, share knowledge, and achieve their full potential in these activities. +## Features 🌟 -we aim to address these challenges by providing a comprehensive platform where students can easily find and connect with peers who share their interests and possess complementary skills. By leveraging advanced AI technology, DevHub-AI will facilitate intelligent matchmaking and personalized recommendations, ensuring that students can form effective teams and engage in meaningful collaborations. The platform will provide a structured and user-friendly environment for networking, learning, and growth, ultimately enhancing the academic and professional experiences of college students. +### Advanced Matchmaking System +DevHub integrates several cutting-edge technologies to create a robust matchmaking experience: -## TechStacks +- **Large Language Model (LLM)**: 🧠 Processes natural language inputs to understand user preferences and extract relevant information, enhancing matchmaking accuracy through: + - Natural Language Processing (NLP) 💬 + - Entity Recognition 🔍 + - Contextual Understanding 📊 -Backend - Flask
-Frontend - Vite + React (typescript)
-Database - Neo4j +- **LangChain**: 🔗 Optimizes workflows by streamlining data integration between components, improving response quality and facilitating connections with external services. -## Features -1. Create your profile -2. Find peers with similar interests and skills -3. chat with peers -4. See others posted projects -5. Get the best Roadmap for development +- **Neo4j Database**: 📈 Stores user profiles and project data in a graph format, allowing for complex relationships to be represented and queried effectively. Key features include: + - Knowledge Graph Creation 🌐 + - Advanced Querying with Cypher 🗄️ + - Integration with External Data Sources 🌍 + +### User Interaction Features +- **Chat Functionality**: 💬 Users can interact with the system to find matches or ask questions about potential collaborations using GraphRAG technology. +- **Visualization Tools**: 📊 Users can visualize their connections within the knowledge graph, aiding in understanding potential collaborations. + +## Tech Stacks 🛠️ + +- **Backend**: Flask 🐍 + LangChain 🔗 +- **Frontend**: Vite + React (TypeScript) ⚛️ +- **Database**: Neo4j 🌐 + Sqlite + +--- + +## Features ✨ + +1. **Create Your Profile**: Set up a personalized profile to showcase your skills and interests. +2. **Find Peers**: Connect with fellow students who share similar interests and complementary skills. +3. **Chat with Peers**: Engage in real-time conversations to discuss projects and collaborations. +4. **Explore Projects**: View projects posted by other users to gain inspiration and insights. +5. **Get Development Roadmaps**: Access curated roadmaps tailored for your development journey. ## Installation -See the [INSTALLATION GUIDE](INSTALLATION.md) for Installing the project locally. +Enter into the root directory. +```bash +cd devhub +``` +Open two terminal for server and client and enter into the directories. +```bash +## 1st terminal for server +cd server + +## Create Virtual Environment +python -m venv venv + +## Activate the virtual Env. +./venv/Scripts/activate + +## Intall dependencies +pip install -r requirements.txt + +## Run the Server +flask run or python server.py +``` +```bash +## 2nd terminal for client +cd client + +## Intall dependencies +npm install + +## Run the client +npm run dev +``` + +## Conclusion 🎉 +By integrating LLMs for natural language understanding, LangChain for workflow enhancement, and Neo4j for advanced data storage and querying, DevHub offers a comprehensive solution for devs seeking meaningful collaborations. This combination not only enhances user experience but also ensures that connections are based on relevant skills and interests, leading to more effective teamwork. ## Contribution -See the [CONTRIBUTION GUIDE](CONTRIBUTION.md) to contribute to the project. +See the [CONTRIBUTION GUIDE](https://github.com/devhub-ai/devhub/blob/main/.github/CONTRIBUTING.md) to get started.