Skip to content

Your AI-Powered Assistant for Seamless Open Source Collaboration.

License

Notifications You must be signed in to change notification settings

mehrinshamim/issueWiz

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

71 Commits
 
 
 
 
 
 
 
 

Repository files navigation

issueWiz 🎯

Basic Details

Team Name: Bonito Flakes

Team Members

  • Member 1: Mehrin Fathima Shamim - Government Model Engineering College, Thrikkakara
  • Member 2: Diya Jojo - Government Model Engineering College, Thrikkakara
  • Member 3: Aswathy S Ajith - Government Model Engineering College, Thrikkakara

Hosted Project Link

https://issue-wiz.vercel.app/

Project Description

IssueWiz is an AI-powered platform designed to lower the barrier to entry for open-source contributions by providing intelligent issue analysis, personalized recommendations, and contextual documentation. The system helps both newcomers and experienced developers navigate complex codebases and find suitable issues to work on.

The Problem statement

Contributing to open-source projects can be challenging, especially for beginners, due to complex codebases, unclear documentation, and difficulty identifying relevant files. Even experienced developers struggle with narrowing down bugs and locating error files in large repositories. Without proper guidance, both beginners and experts end up spending more time searching than solving, making contributions inefficient.

The Solution

IssueWiz simplifies this process by providing the following:

  • Issue Analysis Engine : Analyzes issues, identifies relevant files, and generates contextual documentation with interactive guidance.
  • Skill-Based Issue Matcher : Matches users' skills with suitable issues, providing ranked recommendations for both learning and contribution.
  • Interactive Learning Assistant : Offers real-time, AI-driven assistance for understanding code, troubleshooting, and improving development practices. By lowering these barriers, IssueWiz makes open-source contributions more accessible and engaging for developers of all levels.

Technical Details

Technologies/Components Used

For Software:

  • Languages used: Python, TypeScript
  • Frameworks used: FastAPI, Next.js
  • Libraries used: GitHub API, OpenAI API, SentenceTransformer,ThreadPoolExecuter, aiohttp, numpy
  • Tools used: Render, Vercel

For Hardware:

  • No hardware used in this project.

Implementation

For Software:

Backend (server)

Installation
# Clone the repository
git clone https://github.com/yourusername/issuewiz.git
cd issuewiz/server

# Create a virtual environment and activate it
python -m venv venv
source venv/bin/activate  # On macOS/Linux
venv\Scripts\activate     # On Windows

# Install dependencies
pip install -r requirements-server.txt -r model/requirements-model.txt

# Set up environment variables (GitHub API, OpenAI API, etc.)
# Create a `.env` file and add necessary keys

# Start the backend server
uvicorn app.main:app --reload
Run
# Activate virtual environment
source venv/bin/activate  # On macOS/Linux
venv\Scripts\activate     # On Windows

# Run the backend server
uvicorn app.main:app --reload

Frontend (client)

Installation
# Navigate to the frontend directory
cd ../client

# Install dependencies
npm install

# Set up environment variables if required
# Create a `.env` file and add necessary keys

# Start the frontend server
npm run dev
Run
npm run dev

Project Documentation

For Software:

Screenshots

image issueWiz Landing Page

image issueWiz features

image Repository analysis

image Issue matcher

image issue recommendation page

Project Demo

Video

Youtube - issueWiz - Bonito Flakes Tink-Her-Hack 3.0

Team Contributions

  • Mehrin: Developed the backend with FastAPI and integrated Supabase for user data and authentication.
  • Diya: Worked on the frontend development using Next.js, integrating the GitHub API for issue tracking, and AI-powered documentation.
  • Aswathy: Implemented SentenceTransformer , a deep learning model for issue mapping and code analysis .

Made with ❤️ at TinkerHub

About

Your AI-Powered Assistant for Seamless Open Source Collaboration.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •