MemeHub

A meme generator and sharing platform where users can create and share memes. Users can react to and comment on posts, making it a fun and interactive community for meme lovers.

Requirements

Before running the MemeHub project, make sure you have the following software and tools installed on your machine:

1. Node.js and npm (Node Package Manager) - These are required to run the front end of the project.

2. PHP 8.0 or higher - This is required to run the back end of the project.

3. MariaDB or XAMPP - These are required to set up and run the database for the project.

4. A text editor or IDE (Integrated Development Environment) like PhpStorm - This is required to view and edit the project files.

Once you have all these tools installed, you can proceed with running the project as described in the How to run the project section.

How to run the project:

To run the MemeHub project, follow these steps:

1. Clone the project repository to your local machine.

2. For the front end:

   • Navigate to the front end folder.
   • Run the following commands:

     npm install
     npm start

     This will install the necessary dependencies and start the React development server.

3. For the database:

   • Run your MariaDB server. If you don't have MariaDB installed, you can use XAMPP for an easy setup.
   • Execute the schema.sql file to create the necessary database schema.

4. For the back end:

   • Navigate to the back end folder.
   • Make sure you have PHP 8.0 or higher installed on your machine.
   • Run the following command to start the PHP server:

     php start-server.php

   • If you want to run the server in development mode, you can pass the --dev=true flag to the command:

     php start-server.php --dev=true # or false

   • The server will start on port 8000. You can access the API at http://localhost:8000.
   • You can configure the database connection by modifying the database.php file in the Config folder. Update the database host, username, password, and database name to match your database configuration.
   • For more detailed instructions and information about the project workflow, refer to the README.md file in the back end folder.

5. Once all the necessary components are running, you can access the MemeHub application in your web browser.

Note: Make sure to update any configuration files as needed for your specific setup.

Key Features:

Authentication:

Access your account securely through our authentication system. Log in to access personalized features, log out when finished, or register for a new account to join our community.

Discover Memes:

Explore our curated selection of memes on the home page. From trending topics to niche humor, MemeHub caters to diverse tastes.

Create and Post Memes:

Utilize our intuitive meme generator tool to unleash your creativity. Share your creations with the world and potentially reach viral status.

React and Engage:

Interact with memes by liking and sharing.

View Other Peoples' Profiles:

Explore user profiles to discover their meme collections and contributions. Expand your network and engage with like-minded individuals.

Download Memes:

Easily download memes for offline viewing or sharing with friends and followers on social media platforms.

Edit Your Profile:

Personalize your profile by updating your personal information and preferences. Add or change your profile picture to showcase your unique personality within the community. Additionally, manage your uploaded memes by removing specific ones from your profile, ensuring that your collection reflects your evolving tastes and interests.

Report Inappropriate Content:

Help us maintain a positive community environment by reporting any content that violates our guidelines.

Contact Us:

Have questions or suggestions? Reach out to our support team via email for assistance.

Admin Dashboard

MemeHub's Admin Dashboard provides essential tools for streamlined platform management. Admins can oversee user management, meme moderation, role assignment, access website statistics, and utilize debugging mode for troubleshooting and smooth operation.

Feedback and Support

We value your feedback and suggestions for improving MemeHub! If you have any ideas, encounter issues, or simply want to get in touch, please feel free to reach out to us via email or submit a ticket on our GitHub repository.

Thank you for being a part of the MemeHub community!