/fuckregex

this ai tool(gpt-3.5) is for those who hate regex!

Primary LanguageGoMIT LicenseMIT

fuckregex

A user-friendly AI-powered tool for those who hate writing regular expressions! Powered by GPT-3.5, FuckRegex helps you generate regex patterns without the headache.

Features

  • Generate regex patterns with natural language input
  • Interpret entered regex for better understanding
  • Validate generated regex patterns
  • Generate regex usage examples in popular programming languages

Getting Started

These instructions will help you set up and run the project on your local machine for development and testing purposes.

Prerequisites

Ensure you have golang (v1.20 or later) and postgresql database installed on your system:

Installation

  1. Clone the repository:
git clone https://github.com/sercanarga/fuckregex.git
  1. Go to the project directory:
cd fuckregex
  1. Modify .env file:
nano .env
  1. Create a postgresql database using the sql file under the resources directory.
cat resources/*.sql
  1. Install dependencies:
go mod tidy
  1. Run the API service:
go run cmd/api/main.go
  1. Run the web service:
go run main.go
  1. Open your web browser and visit http://localhost:8181 (replace 8181 with the port number specified in the configuration).

Contributing

We welcome contributions from the community! You can open PRs and issues to help us improve the project.

To-Do

  • Implement request moderation for ChatGPT submissions
  • Improve security measures
  • Add the ability to interpret entered regex
  • Introduce regex validation for generated patterns
  • Generate regex usage examples in popular programming languages
  • Enhance design and source code

License

This project is licensed under the MIT License.

Contributors

Thanks go to these wonderful people


Ertuğrul TURAN
Samet
Murat