# CodeAsk

**Repository Path**: qiang_wan/CodeAsk

## Basic Information

- **Project Name**: CodeAsk
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 0
- **Created**: 2025-02-18
- **Last Updated**: 2025-05-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


<div align="center">
  <img src="images/icons/logo.png" alt="CodeAsk Logo" width="200"/>
  <h3>CodeAsk - Code Analysis Tool</h3>
  <p>Specializes in: Legacy code left by former developers, cryptic open-source projects, self-made spaghetti code, and riddle-like comments.</p>

</div>

<div align="center">

[![License](https://img.shields.io/badge/license-GNU-blue.svg)](LICENSE)
[![Node](https://img.shields.io/badge/node-%3E%3D16-brightgreen.svg)](https://nodejs.org)
[![React](https://img.shields.io/badge/react-%5E19.0.0-blue.svg)](https://reactjs.org/)
[![Electron](https://img.shields.io/badge/electron-latest-blueviolet.svg)](https://www.electronjs.org/)

</div>

## 📖 Introduction

### Are you currently experiencing...:
- Your code breeds like rabbits (I SWEAR I DIDN'T TOUCH THAT FILE!)
- Previous dev was a part-time psychic ("needs optimization" → Optimize WHAT exactly?)
- New hires resign after 3 days ("I've seen code, but this... this is ART")
- Comments saying "temporary fix" (that's been running longer than _Friends_ reruns)
- The moment you understand the mess – congrats, you're now part of the problem

### CodeAsk - How to Survive Legacy Spaghetti Code
CodeAsk is a code analysis tool powered by LLM. It provides:
- Intelligent code organization and analysis
- Security vulnerability detection
- Code quality assessment
- Other interesting code insights

Ultimately, it translates spaghetti code into plain human language, helping you quickly familiarize yourself with the codebase and create the illusion that "I can understand this legacy code." It helps newcomers inherit the legacy mess faster (and then join you in overtime until the ICU).

## 🎥 Preview
<div align="center">
<table>
<tr>
<td align="center" width="50%">
<img src="images/demo-en.gif" alt="CodeAsk Demo" width="100%"/>
</td>
<td align="center" width="50%">
<img src="images/prompts-en.png" alt="CodeAsk Prompts" width="100%"/>
</td>
</tr>
</table>
</div>

## 🚀 Quick Start
1. Clone the project
```bash
git clone https://github.com/woniu9524/CodeAsk.git
```
2. Install dependencies
```bash
cd codeask
npm install --legacy-peer-deps
```
3. Start the application
```bash
npm run start
```

## 💡 Usage Guide
### 1. Project Configuration
- Use `File > Open Folder` to select the target code directory.
- Configure your LLM API key and parameters in the model settings.

### 2. Plugin Creation and Code Analysis
1. Create a plugin
2. Choose an appropriate analysis plugin
3. Start the analysis task to complete the analysis

### 3. Result Viewing
- Supports split-screen comparison
- Markdown format report display
- Mermaid chart support in markdown

### 4. Sharing
- After analysis, a .codeaskdata file will be generated in the project directory
- Share this file with others (they should place it in the same location in their codebase)
- Open the folder in CodeAsk to view the analysis results

## 🔧 Tech Stack
- **Core Framework**
    - React 19
    - Electron
    - TypeScript
- **State Management**
    - Zustand
- **UI Components**
    - Shadcn/ui
    - Monaco Editor
    - ReactMarkdown
- **Development Tools**
    - Vite
    - ESLint
    - Prettier

## ⚠️ Pro Tip
When encountering bugs, chant "It's not a bug, it's a feature" three times before creating an issue. Works 0% of the time but makes you feel better.

Most prompt templates are generated by DeepSeek and many haven't been thoroughly tested - they're meant to provide inspiration for creative use cases. Please adjust them based on your specific model and code requirements.Feel free to share your interesting prompts in the issues section!