Skip to content

Commit 10e5240

Browse files
Update README.md
1 parent 81b78f4 commit 10e5240

File tree

1 file changed

+43
-2
lines changed

1 file changed

+43
-2
lines changed

README.md

+43-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,43 @@
1-
# ChatGPT-wrapper-in-PHP-MySQL
2-
An open source php/mysql app that you can install anywhere that you can run WordPress with a familiar PHP/MySQL code base
1+
# ChatGPT PHP & MySQL Wrapper
2+
3+
Welcome to the ChatGPT PHP & MySQL Wrapper, a powerful and flexible ChatGPT integration for WordPress enthusiasts and developers. This project is born out of a passion for WordPress and a desire to integrate ChatGPT in a familiar environment.
4+
5+
## Why This Project?
6+
7+
With 17 years of experience in building on WordPress, the absence of a PHP MySQL installable ChatGPT wrapper that utilizes personal OpenAI API keys was something I was looking for and didn't find. This project aims to fill that gap, providing a comprehensive package easily deployed in a WordPress-like environment (LAMP stack).
8+
9+
## Features I aim to build
10+
11+
- **Wizard Setup**: Easy-to-follow, step-by-step setup wizard, reminiscent of the WordPress manual installation process.
12+
- **Single Zip Package**: Downloadable in a compact zip format for straightforward deployment.
13+
- **Admin Account**: Create an administrator account to manage app settings.
14+
- **User Management**: Offer paid or free access. Add, ban, or manage users with ease.
15+
- **Self Registration & Payment Integration**: Users can self-register and opt for paid access via Stripe integration.
16+
- **API Key Flexibility**: Users can employ their own OpenAI API keys or use a common one provided in the settings.
17+
- **Static Fire Test**: A feature in the admin settings to ensure basic OpenAI functionality is operational.
18+
- **Customizable Settings**: Apply filtering rules, adjust file upload permissions, code reading, and web browsing capabilities.
19+
- **Custom GPT Instructions and Actions**: Add your own instructions and actions to tailor the GPT experience.
20+
- **Ideal for Custom GPT Integration**: Perfect for those who want to create a clone of their custom GPT built using ChatGPT Pro, complete with payment and user management features.
21+
22+
## Current Status
23+
24+
- **Version**: 0.1 Alpha
25+
- **Note**: The application will not be fully ready for use until it reaches Version 1.0.
26+
27+
## Installation and Setup
28+
29+
1. Download the latest release
30+
2. Install in a LAMP compatible web host
31+
3. Visit {your root folder/install}. Eg: yourdomainnamehere.com/install/
32+
33+
## Contributions
34+
35+
I warmly invite contributions to this project! Whether you have ideas for new features, improvements, or bug fixes, your input is valuable. Feel free to add requests directly on GitHub, or reach out with your suggestions and feedback at [[email protected]](mailto:[email protected]).
36+
37+
## License
38+
39+
This project is open-source and available under the MIT License. This means anyone can use, adapt, fork, and redistribute the project as they see fit.
40+
41+
The MIT License is a permissive license that is short and to the point. It lets people do anything they want with your code as long as they provide attribution back to you and don’t hold you liable.
42+
43+
For the full license text, see [MIT License](https://opensource.org/licenses/MIT).

0 commit comments

Comments
 (0)