KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #typescript #developer-tools #claude-code #ai-agent #codex #deepseek-harness #ai-agents #cli #react #mcp

regex-generator

★ 13 Open GitHub ↗

Geração de Regex validada a partir de critérios simples. Um projeto Vanilla JS/MVC perfeito para o Hacktoberfest.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Gerador de Regex

Um projeto de código aberto para gerar expressões regulares (Regex) validadas a partir de critérios selecionados pelo usuário. Ideal para desenvolvedores que precisam de regex para validação de formulários, processamento de texto e muito mais.

## ✨ Recursos

- **Interface Intuitiva**: Fluxo guiado em 5 etapas simples
- **Sistema de Toasts**: Notificações elegantes em tempo real
- **Múltiplas Categorias**: Email, CPF e muito mais
- **Teste em Tempo Real**: Valide sua regex instantaneamente
- **Cópia Rápida**: Copie regex ou código JavaScript com um clique
- **Design Responsivo**: Funciona perfeitamente em desktop e mobile

## Objetivo

O objetivo central deste projeto é fornecer uma ferramenta acessível e extensível para a criação de regex. Ele foi projetado com foco em ser um projeto de código aberto, incentivando contribuições da comunidade, especialmente durante eventos como o Hacktoberfest.

## Como Rodar Localmente

Para rodar este projeto em sua máquina local, siga os passos abaixo:

1.  **Clone o repositório:**
    ```bash
    git clone https://github.com/seu-usuario/regex-generator.git
    cd regex-generator
    ```

2.  **Instale as dependências:**
    Esse é um projeto Vanilla JavaScript, HTML e CSS. Ele usa um servidor simples com o pacote `http-server`, então é necessário instalar o pacote com um gerenciador de pacotes NodeJS (npm, yarn ou pnpm).

```bash
    npm i
    ```

Ou

```bash
    yarn
    ```

Ou

```bash
    pnpm i
    ```
    
3. **Inicio o projeto**:
    Após a instalação, inicie o projeto com o script `start` e o servidor irá iniciar em [http://localhost:8080](http://localhost:8080).

## 🚀 Como Usar

1. **Escolha uma Categoria**: Selecione o tipo de regex (Email, CPF, etc.)
2. **Configure os Critérios**: Personalize as opções disponíveis
3. **Gere a Regex**: Clique em "Gerar Regex" para criar o padrão
4. **Copie o Resultado**: Use os botões para copiar a regex ou código JavaScript
5. **Teste a Regex**: Valide com exemplos reais no campo de teste

O sistema de toasts irá guiá-lo através de cada etapa com feedback em tempo real!

## Como Contribuir

Este projeto acolhe contribuições de todos! Seja para adicionar novos padrões de regex, melhorar a interface do usuário, corrigir bugs ou aprimorar a documentação. Por favor, leia o arquivo [`CONTRIBUTING.md`](https://github.com/priscillatrevizan/regex-generator/blob/main/CONTRIBUTING.md) para diretrizes detalhadas sobre como contribuir.

Atente-se tambem às regras em [`CÓDIGO DE CONDUTA`](https://github.com/priscillatrevizan/regex-generator/blob/main/CODE_OF_CONDUCT.md)

**Foco principal para contribuições:** Adicionar novas funções e padrões de Regex validados ao arquivo `src/model/regexPatterns.js`.

## 🎃 Hacktoberfest 2025

Este projeto participa oficialmente do **Hacktoberfest**!

### **Issues Abertas para Contribuição:**
- 🟢 Regex para CEP, telefone e RG brasileiros
- 🟡 Regex para senhas seguras e URLs
- 🔵 Melhorias na interface e experiência do usuário
- 🟠 Sistema de modo escuro
- 📝 Documentação e exemplos

### **Como Participar:**
1. Procure issues com labels `hacktoberfest` ou `good-first-issue`
2. Comente na issue para ser assignado
3. Siga o guia em `CONTRIBUTING.md`
4. Abra um Pull Request de qualidade

**Todas as contribuições válidas serão aceitas!** 🚀

---

# Regex Generator by Criteria

An open source project to generate validated regular expressions (Regex) from user-selected criteria. Perfect for developers who need regex for form validation, text processing and much more.

## ✨ Features

- **Intuitive Interface**: Guided flow in 5 simple steps
- **Toast System**: Elegant real-time notifications
- **Multiple Categories**: Email, CPF and much more
- **Real-time Testing**: Validate your regex instantly
- **Quick Copy**: Copy regex or JavaScript code with one click
- **Responsive Design**: Works perfectly on desktop and mobile

## Objective

The main objective of this project is to provide an accessible and extensible tool for creating regex. It was designed with a focus on being an open source project, encouraging community contributions, especially during events like Hacktoberfest.

## How to Run Locally

To run this project on your local machine, follow the steps below:

1.  **Clone the repository:**
    ```bash
    git clone https://github.com/your-username/regex-generator.git
    cd regex-generator
    ```

2. **Install dependencies:**
   This is a Vanilla JavaScript, HTML and CSS project. It uses a simple server with the `http-server` package, so you need to install the package with a NodeJS package manager (npm, yarn or pnpm).

```bash
   npm i
   ```

Or

```bash
   yarn
   ```

Or

```bash
   pnpm i
   ```
   
3. **Start the project:**
   After installation, start the project with the `start` script and the server will start at [http://localhost:8080](http://localhost:8080).

```bash
   npm start
   ```

Or

```bash
   yarn start
   ```

Or

```bash
   pnpm start
   ```

## 🚀 How to Use

1. **Choose a Category**: Select the regex type (Email, CPF, etc.)
2. **Configure Criteria**: Customize available options
3. **Generate Regex**: Click "Generate Regex" to create the pattern
4. **Copy Result**: Use buttons to copy regex or JavaScript code
5. **Test Regex**: Validate with real examples in the test field

The toast system will guide you through each step with real-time feedback!

## How to Contribute

This project welcomes contributions from everyone! Whether to add new regex patterns, improve the user interface, fix bugs or enhance documentation. Please read the `CONTRIBUTING.md` file for detailed guidelines on how to contribute.

**Main focus for contributions:** Add new functions and validated Regex patterns to the `src/model/regexPatterns.js` file.

## 🎃 Hacktoberfest 2025

This project officially participates in **Hacktoberfest**!

### **Open Issues for Contribution:**
- 🟢 Regex for Brazilian CEP, phone and RG
- 🟡 Regex for secure passwords and URLs
- 🔵 Interface and user experience improvements
- 🟠 Dark mode system
- 📝 Documentation and examples

### **How to Participate:**
1. Look for issues with `hacktoberfest` or `good-first-issue` labels
2. Comment on the issue to be assigned
3. Follow the guide in [`CONTRIBUTING.md`](https://github.com/priscillatrevizan/regex-generator/blob/main/CONTRIBUTING.md)
4. Please also pay attention to the rules in [`CODE OF CONDUCT`](https://github.com/priscillatrevizan/regex-generator/blob/main/CODE_OF_CONDUCT.md)
5. Open a quality Pull Request

**All valid contributions will be accepted!** 🚀

regex-generator

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README