An open API service indexing awesome lists of open source software.

https://github.com/lemniscate-world/debugex

A Regex Debugger
https://github.com/lemniscate-world/debugex

javascript learning-tool react regex visualization

Last synced: 4 months ago
JSON representation

A Regex Debugger

Awesome Lists containing this project

README

          

# Debugex - Regex Debugger + Learning Tool

A modern, intuitive tool for debugging and learning regular expressions with step-by-step visualization.

## Features

- **Step-by-Step Execution**: See how your regex pattern matches text one step at a time
- **Pattern Explanations**: Get explanations for common regex patterns
- **Visual Feedback**: Clear visual indication of matches and errors
- **Intuitive UI**: Clean, modern interface that's easy to use

## Getting Started

### Prerequisites

- Node.js 14.x or higher
- npm or yarn

### Installation

1. Clone the repository:
```bash
git clone https://github.com/Lemniscate-world/debugex.git
cd debugex
```

2. Install dependencies:
```bash
npm install
# or
yarn
```

3. Start the development server:
```bash
npm run dev
# or
yarn dev
```

4. Open your browser and navigate to `http://localhost:5173`

## Usage

1. Enter a regex pattern in the "Regex Pattern" field
2. Enter text to match against in the "Test Text" field
3. Click "Execute Regex" to run the pattern against the text
4. Use the "Previous Match" and "Next Match" buttons to navigate through matches
5. Read the explanation of your regex pattern

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

## License

This project is licensed under the MIT License - see the LICENSE file for details.

## Acknowledgments

- Thanks to all contributors and supporters of this project
- Inspired by tools like Regex101 and Debuggex

## Support

If you find this tool useful, please consider sponsoring the project to help with maintenance and new features.

[![Support on Ko-fi](https://img.shields.io/badge/Support-Ko--fi-FF5E5B.svg)](https://ko-fi.com/kuroio)
[![GitHub](https://img.shields.io/badge/View_on-GitHub-blue.svg)](https://github.com/Lemniscate-world/debugex)

# NEXT

- VSCODE Integration
- More intuitive step by step visualization