/v-chatgpt-social-status-feeds

V-chatgpt-social-status-feeds is a robust application designed to generate and manage automated social media status updates using the ChatGPT API. It facilitates user account creation, handles authentication, and enforces API usage limits.

Primary LanguagePHPMIT LicenseMIT

❯ REPLACE-ME

Empower Your Status, Simplify Your Sharing!

Built with the tools and technologies:

PHP


πŸ”— Table of Contents

πŸ“ Overview

The ChatGPT API Status Generator addresses the need for seamless social media management by automating status updates across platforms. Key features include user-friendly dashboards, secure account management, and automated scheduling. Ideal for social media managers and businesses, it enhances engagement and efficiency, simplifying the process of maintaining an active online presence.

πŸ‘Ύ Features

Feature Summary
βš™οΈ Architecture
  • Built primarily in <PHP> with a focus on modular design.
  • Utilizes a structured approach for configuration management through root/config.php.
  • Incorporates a database management layer via root/db.php for data persistence and structured interactions.
πŸ”© Code Quality
  • Follows best practices for secure coding, including CSRF protection in forms.
  • Utilizes clear naming conventions and organized file structure for maintainability.
  • Includes utility functions in root/lib/common-lib.php to enhance code reusability.
πŸ“„ Documentation
  • Documentation is primarily in <PHP> with a focus on user guides and API integration.
  • Code comments and structured file organization enhance understanding of functionality.
  • Limited external documentation; could benefit from a dedicated README or wiki.
πŸ”Œ Integrations
  • Integrates with the <ChatGPT API> for generating social media statuses.
  • Supports RSS feed generation for user updates via root/lib/rss-lib.php.
  • Handles user authentication and session management through root/lib/auth-lib.php.
🧩 Modularity
  • Modular design allows for easy updates and maintenance of individual components.
  • Separation of concerns with distinct files for user management, account handling, and status updates.
  • Utilizes helper functions to streamline operations across different modules.
πŸ§ͺ Testing
  • Testing commands are not explicitly defined; consider implementing unit tests for critical components.
  • Encourages validation checks in forms to ensure data integrity.
  • Automated tasks handled in root/cron.php can be monitored for performance and reliability.
⚑️ Performance
  • Optimizes performance through caching mechanisms in root/public/.htaccess.
  • Scheduled tasks in root/cron.php help maintain optimal resource management.
  • Efficient database interactions ensure quick data retrieval and updates.
πŸ›‘οΈ Security
  • Implements user authentication and session management to secure access.
  • Utilizes CSRF tokens in forms to prevent cross-site request forgery.
  • Includes IP blacklisting in root/lib/auth-lib.php to enhance security against unauthorized access.
πŸ“¦ Dependencies
  • Minimal dependencies, primarily relying on <PHP> and configuration files like robots.txt and .htaccess.
  • Ensures compatibility with web servers through proper configuration.
  • Lightweight structure allows for easy deployment and management.

πŸ“ Project Structure

└── /
    β”œβ”€β”€ CHANGELOG.md
    β”œβ”€β”€ LICENSE
    β”œβ”€β”€ README.md
    β”œβ”€β”€ root
    β”‚   β”œβ”€β”€ app
    β”‚   β”‚   β”œβ”€β”€ forms
    β”‚   β”‚   β”‚   β”œβ”€β”€ accounts-forms.php
    β”‚   β”‚   β”‚   β”œβ”€β”€ home-forms.php
    β”‚   β”‚   β”‚   β”œβ”€β”€ info-forms.php
    β”‚   β”‚   β”‚   └── users-forms.php
    β”‚   β”‚   β”œβ”€β”€ helpers
    β”‚   β”‚   β”‚   β”œβ”€β”€ accounts-helper.php
    β”‚   β”‚   β”‚   β”œβ”€β”€ home-helper.php
    β”‚   β”‚   β”‚   └── users-helper.php
    β”‚   β”‚   └── pages
    β”‚   β”‚       β”œβ”€β”€ accounts.php
    β”‚   β”‚       β”œβ”€β”€ home.php
    β”‚   β”‚       β”œβ”€β”€ info.php
    β”‚   β”‚       └── users.php
    β”‚   β”œβ”€β”€ config.php
    β”‚   β”œβ”€β”€ cron.php
    β”‚   β”œβ”€β”€ db.php
    β”‚   β”œβ”€β”€ lib
    β”‚   β”‚   β”œβ”€β”€ auth-lib.php
    β”‚   β”‚   β”œβ”€β”€ common-lib.php
    β”‚   β”‚   β”œβ”€β”€ load-lib.php
    β”‚   β”‚   β”œβ”€β”€ rss-lib.php
    β”‚   β”‚   └── status-lib.php
    β”‚   └── public
    β”‚       β”œβ”€β”€ .htaccess
    β”‚       β”œβ”€β”€ assets
    β”‚       β”‚   β”œβ”€β”€ css
    β”‚       β”‚   β”‚   β”œβ”€β”€ index.php
    β”‚       β”‚   β”‚   β”œβ”€β”€ login.css
    β”‚       β”‚   β”‚   β”œβ”€β”€ mobile.css
    β”‚       β”‚   β”‚   β”œβ”€β”€ pages.css
    β”‚       β”‚   β”‚   └── styles.css
    β”‚       β”‚   β”œβ”€β”€ images
    β”‚       β”‚   β”‚   β”œβ”€β”€ background-marble.png
    β”‚       β”‚   β”‚   β”œβ”€β”€ default.jpg
    β”‚       β”‚   β”‚   β”œβ”€β”€ default.png
    β”‚       β”‚   β”‚   β”œβ”€β”€ index.php
    β”‚       β”‚   β”‚   └── logo.png
    β”‚       β”‚   β”œβ”€β”€ index.php
    β”‚       β”‚   └── js
    β”‚       β”‚       β”œβ”€β”€ footer-scripts.js
    β”‚       β”‚       β”œβ”€β”€ header-scripts.js
    β”‚       β”‚       └── index.php
    β”‚       β”œβ”€β”€ favicon.ico
    β”‚       β”œβ”€β”€ feeds.php
    β”‚       β”œβ”€β”€ images
    β”‚       β”‚   └── index.php
    β”‚       β”œβ”€β”€ index.php
    β”‚       β”œβ”€β”€ login.php
    β”‚       └── robots.txt
    └── v-chatgpt-social-status-feeds.png

πŸ“‚ Project Index

/
__root__
root
config.php - Configuration settings are defined for the ChatGPT API Status Generator, encompassing essential parameters such as API keys, endpoints, model preferences, and database connection details
- These settings facilitate the integration and functionality of the application, ensuring proper communication with the OpenAI API while managing system behavior and data handling, ultimately supporting the generation of social media status updates.
db.php - Database management is established through a script that facilitates connection setup and table initialization for the ChatGPT API project
- It ensures the creation of essential tables for user management, account details, and logging, while also handling installation checks and version updates
- This foundational component supports the overall architecture by enabling data persistence and structured interactions within the application.
cron.php - Handles scheduled tasks within the ChatGPT API project, ensuring efficient management of resources and user accounts
- It resets API usage, updates statuses, clears IP blacklists, and purges outdated images
- By automating these processes, it maintains optimal performance and compliance with usage limits, contributing to the overall stability and reliability of the application.
public
index.php - Serves as the main dashboard for the ChatGPT API Status Generator, functioning as the entry point for the admin interface
- It facilitates user interactions by providing navigation tabs for various sections, including statuses, accounts, and user management, while dynamically loading content based on user roles
- Additionally, it integrates essential scripts and styles for a cohesive user experience, ensuring a responsive and interactive dashboard.
.htaccess - Facilitates URL rewriting and caching for a web application, enhancing user experience and performance
- It serves a default image when specific PNG files are missing, redirects certain requests to a home page, and internally rewrites paths for seamless navigation
- Additionally, it manages cache control for various file types, optimizing load times and resource management across the project.
login.php - Facilitates user authentication for the ChatGPT API project by providing a login interface for administrators
- It establishes a session, includes necessary configuration and library files, and renders a form for username and password input
- Additionally, it displays error messages related to login attempts, ensuring secure access to the admin functionalities of the application.
robots.txt - Facilitates web crawling management by specifying directives for search engine bots
- The inclusion of a crawl-delay parameter helps control the frequency of requests made by crawlers, ensuring optimal server performance and resource allocation
- This contributes to the overall architecture by enhancing site visibility while maintaining stability, aligning with the project's goal of efficient web presence management.
feeds.php - Generates an RSS feed for the ChatGPT API tailored to specific user accounts
- By validating and sanitizing input parameters, it ensures secure access to personalized content
- This functionality enhances user engagement by providing a streamlined way for users to receive updates related to their accounts, thereby integrating seamlessly into the overall architecture of the project.
images
index.php - Prevents direct access to the images directory by terminating script execution
- This mechanism enhances security within the project structure, ensuring that sensitive files are not exposed to unauthorized users
- By controlling access at this level, the architecture maintains integrity and confidentiality of the resources stored in the public images directory, contributing to the overall robustness of the application.
app
forms
home-forms.php - Handles the generation and deletion of status updates for users interacting with the ChatGPT API
- It validates user actions through CSRF protection, manages API call limits, and updates the database accordingly
- Additionally, it ensures the removal of associated image files when a status is deleted, maintaining the integrity of user data and enhancing the overall user experience within the application.
info-forms.php - Facilitates user password updates within the ChatGPT API project by handling form submissions securely
- It validates input, checks for CSRF tokens, ensures password compliance, and updates the user's password in the database after hashing
- Success and error messages are managed through session variables, enhancing user experience and security in the application’s authentication process.
users-forms.php - User management functionality is facilitated through the handling of user creation, modification, and deletion within the ChatGPT API project
- It ensures secure input validation, password management, and session handling while providing feedback to users
- Additionally, it supports administrative actions, such as logging in as another user, thereby enhancing the overall user experience and system integrity within the application architecture.
accounts-forms.php - Account management functionality is provided, enabling users to create, edit, and delete accounts associated with the ChatGPT API
- It ensures data integrity through validation checks and handles user input securely, including CSRF protection
- Additionally, it manages database interactions for storing account details and related statuses, facilitating a seamless user experience within the broader project architecture.
helpers
accounts-helper.php - Generates user account details and management options for a ChatGPT API application
- It retrieves and displays essential account information, including usage statistics and expiration dates, while also providing dropdown options for scheduling tasks
- Additionally, it facilitates the display and management of multiple user accounts, allowing for updates and deletions, thereby enhancing user experience and interaction within the overall application architecture.
users-helper.php - Generates a comprehensive user list for the ChatGPT API, displaying essential user data attributes and providing interactive options for updating, deleting, or logging in as a user
- This functionality enhances user management within the application, facilitating administrative tasks and improving overall user experience by presenting relevant information in a structured HTML format.
home-helper.php - Generates a set of interactive share buttons for status updates within the ChatGPT API project
- These buttons facilitate sharing text and images, as well as deleting statuses, enhancing user engagement and functionality
- By providing a seamless interface for sharing and managing content, it contributes to the overall user experience and interactivity of the application.
pages
info.php - Facilitates user password management within the ChatGPT API project by providing a secure interface for changing passwords
- It ensures user authentication through session management and CSRF protection, enhancing overall security
- This component plays a crucial role in maintaining user account integrity and contributes to the user experience by allowing seamless password updates.
accounts.php - Facilitates the management of user accounts within the ChatGPT API project by providing a user-friendly interface for adding and updating account information
- It allows users to specify account details, select social media platforms, and schedule posts, while ensuring security through CSRF tokens
- Additionally, it displays existing account information and error messages, enhancing the overall user experience in account management.
users.php - Facilitates user management within the ChatGPT API project by providing a user interface for adding and updating user details
- It allows administrators to input essential information such as username, password, account limits, and API call settings
- Additionally, it dynamically generates a list of existing users, enhancing the overall user administration experience while ensuring secure interactions through CSRF protection.
home.php - Generates a user-friendly interface for managing and displaying the status of ChatGPT API accounts
- It retrieves user accounts, displays their statuses, and allows users to generate new statuses or view feeds
- The interactive elements enhance user engagement by enabling status sharing and toggling visibility of status details, contributing to a cohesive experience within the overall project architecture focused on API management and user interaction.
lib
rss-lib.php - Generates an RSS feed for user status updates, allowing users to access and subscribe to updates from specific accounts or all accounts owned by a user
- By retrieving and organizing status information from the database, it constructs a well-formed RSS XML output, enhancing user engagement and providing a streamlined way to follow updates within the ChatGPT API project.
auth-lib.php - Authentication logic facilitates user login and logout processes within the ChatGPT API project
- It manages session states, verifies user credentials, and implements security measures such as session regeneration and CSRF token generation
- Additionally, it handles failed login attempts and blacklists IP addresses to enhance security, ensuring a robust and secure user experience across the application.
common-lib.php - Utility functions enhance the ChatGPT API project by ensuring secure user input handling, managing session messages, and overseeing IP blacklist operations
- They facilitate user and account information retrieval, status updates, and API usage tracking, contributing to a robust architecture that prioritizes security and efficient data management
- Overall, these functions support the seamless operation and integrity of the application.
status-lib.php - Generates dynamic status updates for various social media platforms by retrieving account information and utilizing an API to create engaging content
- It also creates associated images based on the generated status, appends relevant hashtags, and manages token usage and costs in the database
- This functionality enhances user engagement and streamlines content creation within the ChatGPT API project.
load-lib.php - Facilitates user access control and page loading for the ChatGPT API project by verifying user authentication and IP address status
- It ensures that only authorized users can access specific pages and includes necessary helper and forms files based on user permissions
- This mechanism enhances security and user experience within the overall architecture of the application.

πŸš€ Getting Started

β˜‘οΈ Prerequisites

Before getting started with the installation, ensure your runtime environment meets the following requirements:

  • Web Server: Apache
  • Programming Language: PHP 7.4+
  • Database: MySQL

βš™οΈ Installation

Install the project using the following steps:

  1. Upload Files:

    • Upload all the project files to your hosting server.

  2. Set Webroot:

    • Set the public folder as the webroot directory on your hosting server.

  3. Update Configuration:

    • Open root/config.php and update the necessary variables, including MySQL database credentials.

  4. Install Database:

    • Load the application in your web browser. The application will automatically install the database.

  5. Default Login:

    • Use the default login credentials: admin for both username and password.

  6. Set Up Cron Jobs:

    • Add the following cron jobs to automate tasks: 
       /usr/bin/php /PATH-TO-CRON.PHP/cron.php reset_usage 0 12 1 * *
 /usr/bin/php /PATH-TO-CRON.PHP/cron.php clear_list 0 12 * * *
 /usr/bin/php /PATH-TO-CRON.PHP/cron.php run_status 0 * * * *
 /usr/bin/php /PATH-TO-CRON.PHP/cron.php cleanup 0 12 * * *
    • Replace /PATH-TO-CRON.PHP/ with the actual path to your cron.php file.

πŸ€– Usage

Login as admin with the password admin. Follow these steps:

  1. Create or Change Users:

    • Navigate to the User tab.
    • Add or update user details as needed.

  2. Create Status Campaigns:

    • Go to the Account tab.
    • Click on Add/Update New Account.
    • Fill in the following details:
      • Account Name
      • Platform
      • Prompt
      • Link
      • Image Instructions
      • Days
      • Post Schedule
      • Include Hashtags
    • Click Add/Update.

Statuses are generated on schedule and added to the respective account feed and the user's collective omni feed. Use the feed with tools like IFTTT to update social media.

Run using the following command: ❯ echo 'INSERT-RUN-COMMAND-HERE'

πŸ“Œ Project Roadmap

  • Task 1: Implement feature one.
  • Task 2: Implement feature two.
  • Task 3: Implement feature three.

πŸŽ— License

This project is licensed under the MIT License. For more details, refer to the LICENSE file.