README

FunnyQuoteLib

An awesome README template to discover this project!
Explore the docs »

View Demo · Report Bug · Request Feature

About The Project

Welcome to FunnyQuoteLib, the PHP library that injects a dose of humor into your web applications! Our mission is to bring a lively and delightful touch to your admin interfaces by incorporating randomly selected, witty quotes.

Picture a world where your users are greeted with funny and inspiring quotes every time they interact with your application. FunnyQuoteLib makes it easy to seamlessly integrate humorous quotes, enhancing the user experience and adding a playful element to your project.

Transform the mundane into the extraordinary by infusing elements of surprise into your pages. FunnyQuoteLi offers a straightforward and effective solution to brighten up your interfaces, creating a light-hearted and entertaining atmosphere. Make each user interaction a memorable experience with our library, adding a dash of humor to your code. Get ready to astonish your users and make your project as enjoyable as it is functional with FunnyQuoteLib!

(back to top)

Built With

(back to top)

Getting Started

Prerequisites

Before you begin, ensure that you have the following prerequisites installed:

PHP (version ^7.1)
Composer 

Installation

1. Install FunnyQuoteLi using Composer:

   composer require ol.arno/funny-quote-lib

2. Once the installation is complete, include the autoloader in your project:

   require_once 'vendor/autoload.php';

(back to top)

Usage

1. Create an instance of the FunnyQuoteLib class:

   use FunnyQuoteLib\FunnyQuoteLibrary;
   
   $funnyQuoteLib = new FunnyQuoteLibrary();

2. Retrieve a random funny quote:

   $quote = $funnyQuoteLib->getRandomQuote();

3. Customize the display to fit your application's needs.

(back to top)

Roadmap

• Add Changelog

  • Keep track of version changes, bug fixes, and new features in the Changelog to enhance transparency and user understanding.

• Improve Readme

  • Implement convenient "Back to Top" links for a smoother and more user-friendly navigation experience.

• Multi-language Support

  • Enable support for multiple languages to cater to a broader audience. This could involve translation efforts and language-specific configurations.

• Explore New Ways to Generate Quotes

  • Investigate innovative methods for generating quotes, potentially incorporating external APIs, user contributions, or dynamic content to keep the quotes fresh and engaging.

• Documentation Updates

  • Ensure that the documentation is comprehensive and up-to-date, covering installation, usage, configuration, and any advanced features. Clear documentation is key for user adoption and contributions.

• Unit Tests

  • Implement a robust suite of unit tests to validate the functionality of your library. This helps maintain stability during development and provides a solid foundation for future updates.

• Continuous Integration (CI)

  • Set up a CI pipeline to automate testing and deployment processes. This ensures that your library remains reliable and consistent across different environments.

• Community Engagement

  • Foster a community around your project by encouraging discussions, addressing issues promptly, and welcoming contributions. A vibrant community can lead to valuable insights and improvements.

• User Feedback Mechanism

  • Establish a feedback mechanism, such as a survey or user forum, to gather insights from users. This can inform future development and ensure that your library meets the evolving needs of its users.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Thank you for considering contributing to FunnyQuoteLi! We welcome contributions from the community to help make this project even better. Whether you're reporting a bug, suggesting an enhancement, or contributing code, your involvement is highly valued.

Ways to Contribute

There are several ways to contribute to FunnyQuoteLib:

1. Bug Reports:

   • Encountered a bug or unexpected behavior? Open an issue on GitHub. Provide a detailed description, steps to reproduce, and information about your environment.

2. Feature Requests:

   • Have an idea for a new feature or improvement? Submit a feature request on GitHub. We welcome your feedback and creativity.

3. Code Contributions:

   • Interested in contributing code? Follow these steps:
     • Fork the repository.
     • Create a new branch for your feature or bug fix.
     • Make your changes and submit a pull request (PR) to the main branch.

4. Propose New Quotes:

   • Help enrich our collection of quotes by submitting pull requests with new and funny quotes. Follow these guidelines:
     • Ensure that the quote is genuinely humorous and aligns with the tone of FunnyQuoteLib.
     • Include the quote along with any relevant attribution or context.
     • Verify that the quote adheres to copyright and licensing requirements.
     • Please target the quotes-submissions branch when submitting your pull request.

We appreciate your contribution in making FunnyQuoteLib a source of laughter and joy!

1. Documentation Improvements:
   • Enhance our documentation by submitting pull requests for clarifications, corrections, or additional information.

We appreciate and welcome contributions from the community to make FunnyQuoteLib even more entertaining and enjoyable!

Here are our contributors: Contributors 😊

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Arnaud Oltra - @arno_ol - arnaudoltra@hotmail.fr

Project Link: https://github.com/olarno/funnyQuoteLibrary

(back to top)