Skip to content

protos50/git-ruled-based-tutor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Git Interactive Tutor 🚀

An intelligent rule-based assistant designed to teach and practice Git interactively. It uses pattern-matching and a small knowledge base to guide the user step-by-step, explain commands, visualize effects, and help resolve common Git issues.

🤖 Note on Development: This project was designed and programmed with the assistance of Artificial Intelligence. It serves as a dual example: on one hand, it teaches the fundamentals of classical AI techniques (rule-based reasoning + knowledge lookup), and on the other, it demonstrates how modern generative AI can accelerate and enhance software development.

🌟 Key Features

  • 🤖 Assistant Chat: Answers questions about Git commands, concepts, and workflows.
  • 🖥️ Terminal Simulator: Executes commands like git init, git commit, git merge in a safe environment and visualizes real output.
  • 📚 Knowledge Base: Detailed explanations, common flags, and warnings for frequent errors.
  • 🌍 Bilingual Support: Structure prepared for both Spanish and English.
  • ⚡ Visual Feedback: Modern interface built with Next.js that displays the simulated repository state.

🛠️ Tech Stack

  • Frontend:
    • Next.js 15 (App Router)
    • React 19
    • Tailwind CSS
    • Lucide React (Icons)
  • Backend:
    • Python 3.x
    • Flask (REST API)
    • JSON-based data management (no heavy database required)

🚀 How to Run

Prerequisites

  • Node.js and npm
  • Python 3.8+

1. Setup Backend

cd backend
python -m venv venv
# On Windows:
.\venv\Scripts\activate
# On Mac/Linux:
source venv/bin/activate

pip install -r requirements.txt
python app.py

The server will run at http://localhost:5000.

2. Setup Frontend

In a new terminal:

cd frontend
npm install
npm run dev

Open http://localhost:3000 in your browser.

📂 Project Structure

├── backend/
│   ├── core/           # Agent logic and simulator
│   ├── knowledge/      # Knowledge base (JSON)
│   └── app.py          # Flask entry point
├── frontend/
│   ├── components/     # React components (Chat, Terminal)
│   └── app/            # Next.js pages
└── plan_desarollo.md   # Project roadmap

🎓 Academic Context

Developed as Prototype 1 for the Artificial Intelligence course.

About

An intelligent rule-based assistant designed to teach and practice Git interactively. It uses pattern-matching and a small knowledge base to guide the user step-by-step, explain commands, visualize effects, and help resolve common Git issues.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors