mirror of https://github.com/vee1e/GDB-UI.git synced 2026-09-01 10:48:57 +00:00

mirror of https://github.com/vee1e/GDB-UI - GDB stands for GNU Debugger. It's a powerful and popular deb

Find a file

yuno 126f874bcc Merge pull request #1 from vee1e/fix/state-management-race-condition Refactor State Management to Fix Refresh Race Condition		2026-03-08 19:07:42 +05:30
.github	minor changes	2024-06-30 17:07:25 +05:30
gdbui_server	fix: correct get_locals to use info locals command	2026-01-09 21:09:32 +05:30
manifest	added kubernetes for managing docker file	2025-06-01 19:15:30 +05:30
webapp	Refactor state management and fix refresh race condition	2026-03-08 19:05:14 +05:30
docker-compose.yml	Added docker file	2024-06-22 14:49:21 +05:30
LICENSE	Initial commit	2024-02-12 05:55:06 +11:00
README.md	Update README.md	2025-01-17 23:03:52 +05:30

README.md

GDB-UI

GDB-UI is a user-friendly interface built for the GNU Debugger (GDB), providing a modern web-based UI for debugging your applications. It allows developers to monitor program execution, inspect variables, set breakpoints, and more, all through an intuitive web application.

GitHub Repository: c2siorg/GDB-UI

Project Overview

GDB-UI simplifies the debugging process by integrating the powerful features of GDB with a sleek and easy-to-use web interface. This project is particularly useful for developers working with languages like C, C++, and Ada. The interface offers a more accessible and visual approach to debugging, making it easier to identify and fix issues in your code.

Getting Started

Docker Setup

The quickest way to get started with GDB-UI is by using Docker. A docker-compose.yml file is provided to handle the entire setup.

Ensure Docker and Docker Compose are installed on your machine.
Run the following command in your terminal:
```
docker-compose up
```

This command will build and start both the frontend and backend services, making the application available at http://localhost:3000 (or your specified port).

Manual Setup

If you prefer a manual setup or are unable to use Docker, follow these steps:

Prerequisites

Node.js: Version 18
Python: Version 3.10

Frontend Setup (React)

Navigate to the webapp directory:
```
cd webapp
```
Install the necessary dependencies:
```
npm install
```
Start the development server:
```
npm run dev
```

Backend Setup (Python Server)

Navigate to the gdbui_server directory:
```
cd gdbui_server
```
Install the required Python packages:
```
pip install -r requirements.txt
```
Run the backend server:
```
python main.py
```

Running Tests

Frontend Tests (Vite)

To run the frontend tests, follow these steps:

Navigate to the webapp directory:
```
cd webapp
```
Run the tests using Vite:
```
npm run test
```

Backend Tests

To run the backend tests, use the following procedure:

Ensure your Python environment is set up as described in the manual setup.
Navigate to the gdbui_server directory:
```
cd gdbui_server
```
Run the tests using the unittest module:
```
python -m unittest discover -s tests
```

Contributing

We welcome contributions from the community! To get started:

Fork the repository at c2siorg/GDB-UI.

Clone your fork:

git clone https://github.com/your-username/GDB-UI.git

Create a new branch for your feature or bugfix:
```
git checkout -b feature-name
```

Make your changes and commit them:

git commit -m "Description of your changes"

Push your branch to your fork:
```
git push origin feature-name
```
Open a pull request on the main repository.

Please ensure your code adheres to our coding standards and is thoroughly tested before submitting your pull request.

Design

https://www.figma.com/proto/flJ4HBaH4QhF18RSKGOWwA/GDB-UI?type=design&node-id=111-1101&t=sDAc1dWc1LAfqpaT-0&scaling=min-zoom&page-id=0%3A1&starting-point-node-id=111%3A2956