From 76b3f282895dcb45ad870ac6e00299548e5d00e9 Mon Sep 17 00:00:00 2001 From: Samet Date: Sun, 26 Mar 2023 20:26:15 +0300 Subject: [PATCH 1/6] updated readme file with a better template #4 --- README.md | 77 ++++++++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 68 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 8f70c00..5f03ef0 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,69 @@ # fuckregex -this ai tool(gpt-3.5) is for those who hate regex! - -### to-do's -- [ ] security problems will be improved -- [ ] the submitted request will be checked for moderation in chatgpt -- [ ] will add the ability to interpret the entered regex -- [ ] will introduce the ability to validate generated regex -- [ ] generate examples in programming languages for the generated regex -- [ ] design and source code will be improved + +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](https://golang.org/dl/) (v1.20 or later) installed on your system: + +### Installation + +1. Clone the repository: + +```bash +git clone https://github.com/yourusername/fuckregex.git +```` + +2. Change to the project directory: + +```bash +cd fuckregex +``` + +3. Install dependencies: + +```bash +go mod tidy +``` + +4. Run the project: + +```bash +go run main.go +``` + +5. Open your web browser and visit `http://localhost:PORT` (replace `PORT` with the port number specified in the configuration). + +## Usage + +1. (Add a step-by-step guide on how to use the application) +2. ... +3. ... + +## Contributing + +We welcome contributions! Please read the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information on how to contribute to this project. + +## To-Do + +- [ ] Improve security measures +- [ ] Implement request moderation for ChatGPT submissions +- [ ] 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](LICENSE.md). From edaf0c14092eef2b05f79a383f96e62858cd1836 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sercan=20Ar=C4=9Fa?= Date: Sun, 26 Mar 2023 20:30:39 +0300 Subject: [PATCH 2/6] Update README.md --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 5f03ef0..adc99c6 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ Ensure you have [golang](https://golang.org/dl/) (v1.20 or later) installed on y 1. Clone the repository: ```bash -git clone https://github.com/yourusername/fuckregex.git +git clone https://github.com/sercanarga/fuckregex.git ```` 2. Change to the project directory: @@ -37,19 +37,19 @@ cd fuckregex go mod tidy ``` -4. Run the project: +4. Run the API service: ```bash -go run main.go +go run cmd/api/main.go ``` -5. Open your web browser and visit `http://localhost:PORT` (replace `PORT` with the port number specified in the configuration). +5. Run the web service: -## Usage +```bash +go run main.go +``` -1. (Add a step-by-step guide on how to use the application) -2. ... -3. ... +5. Open your web browser and visit `http://localhost:8181` (replace `8181` with the port number specified in the configuration). ## Contributing From dec9430d35d4e478c98bbed40a2868f10f1c45aa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sercan=20Ar=C4=9Fa?= Date: Sun, 26 Mar 2023 20:31:19 +0300 Subject: [PATCH 3/6] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index adc99c6..0c62146 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ Ensure you have [golang](https://golang.org/dl/) (v1.20 or later) installed on y git clone https://github.com/sercanarga/fuckregex.git ```` -2. Change to the project directory: +2. Go to the project directory: ```bash cd fuckregex From 00f5080e046ac8252f4562111a7e3a713a4ce4eb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sercan=20Ar=C4=9Fa?= Date: Sun, 26 Mar 2023 20:34:25 +0300 Subject: [PATCH 4/6] Update README.md --- README.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 0c62146..a905f60 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ These instructions will help you set up and run the project on your local machin ### Prerequisites -Ensure you have [golang](https://golang.org/dl/) (v1.20 or later) installed on your system: +Ensure you have [golang](https://golang.org/dl/) (v1.20 or later) and postgresql database installed on your system: ### Installation @@ -31,25 +31,32 @@ git clone https://github.com/sercanarga/fuckregex.git cd fuckregex ``` -3. Install dependencies: +3. Modify `.env` file: +```bash +nano .env +``` + +4. Create a postgresql database using the sql file under the `resources` directory. + +5. Install dependencies: ```bash go mod tidy ``` -4. Run the API service: +6. Run the API service: ```bash go run cmd/api/main.go ``` -5. Run the web service: +7. Run the web service: ```bash go run main.go ``` -5. Open your web browser and visit `http://localhost:8181` (replace `8181` with the port number specified in the configuration). +8. Open your web browser and visit `http://localhost:8181` (replace `8181` with the port number specified in the configuration). ## Contributing From 4ca195daceceb08e7b66aeaf474dcd24fb1c6946 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sercan=20Ar=C4=9Fa?= Date: Sun, 26 Mar 2023 20:35:08 +0300 Subject: [PATCH 5/6] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a905f60..b818a1b 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ These instructions will help you set up and run the project on your local machin ### Prerequisites -Ensure you have [golang](https://golang.org/dl/) (v1.20 or later) and postgresql database installed on your system: +Ensure you have [golang](https://golang.org/dl/) (v1.20 or later) and [postgresql](https://www.postgresql.org/) database installed on your system: ### Installation From 7398fd70337929dbdf4539e34638e848af79a4fc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sercan=20Ar=C4=9Fa?= Date: Sun, 26 Mar 2023 20:50:58 +0300 Subject: [PATCH 6/6] Update README.md --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index b818a1b..faeb40a 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,9 @@ nano .env ``` 4. Create a postgresql database using the sql file under the `resources` directory. +```bash +cat resources/*.sql +``` 5. Install dependencies: