Valik3201 / pixify

Web application that allows users to search and display images using the Pixabay API.

Home Page:https://valik3201.github.io/pixify/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool


logo

HTTP Requests, REST API, pagination, and async/await

Search and display images using Pixabay API with features like pagination, image cards, and more.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Built With
  3. Getting Started
  4. Usage
  5. Roadmap
  6. Contributing
  7. Contact
  8. Acknowledgments

About The Project

screenshot

Pixify - Image Search is a web application that allows users to search and display images using the Pixabay API. The project includes features such as HTTP requests, image cards, pagination, SimpleLightbox library integration, smooth page scrolling, and even infinite scrolling.

Note

The project is set up for automatic deployment to GitHub Pages using GitHub Actions by JamesIves (GitHub Pages Deployment Action). The deployment action is configured to push production-ready code into the gh-pages branch.

HTTP Requests

The search form in the HTML document allows users to enter a search string. Upon submitting the form, an HTTP request is made to the Pixabay API using the specified query parameters. If no images match the query, a notification is displayed.

Gallery and Image Card

The gallery displays image cards, each containing a small image, image information, and statistics. The gallery content is cleared when searching with a new keyword to avoid confusing results.

Pagination

Pixabay API supports pagination, and the project includes a "Load more" button. With each request, the page parameter is increased, and when searching with a new keyword, the page is reset. If the user reaches the end of the collection, a notification is displayed.

SimpleLightbox Library

Large images are displayed using the SimpleLightbox library, which is integrated into the project. Each image card is wrapped in a link, and the library's refresh() method is called after adding a new group of image cards.

Page Scrolling

Smooth page scrolling is implemented after each request and rendering of the next group of images.

Infinite Scrolling

In addition to the "Load More" button, the project enables infinite loading of images when scrolling the page.

Note: The "Load More" button is accessible during input search, while Infinite Scrolling is available for popular list searches.

Back to top

Built With

Back to top

Getting Started

This section provides information on prerequisites and installation steps to set up the Pixify - Image Search project locally.

Prerequisites

Make sure you have the following installed:

Installation

  1. Clone the repository
    git clone https://github.com/Valik3201/pixify.git
  2. Navigate to the project directory
     cd goit-js-hw-11
  3. Install dependencies
     npm install
    

Back to top

Usage

Pixify - Image Search provides a user-friendly interface for searching and displaying images using the Pixabay API. Follow the steps below to explore and make the most of the application:

  1. Open the web application in your browser.
  2. Enter a search query in the provided text field.
  3. Click the "Search" button or press Enter to initiate the search.
  4. Explore the gallery to view image cards, each containing a small image, information, and statistics.
  5. Click on an image card to view the larger image using the SimpleLightbox library.
  6. Scroll through the gallery and enjoy smooth page scrolling after each request.
  7. Use the "Load more" button or experience infinite scrolling for additional images.
  8. Keep an eye on notifications for search results, the end of the collection, or any issues encountered.

Feel free to experiment with different search queries and enjoy discovering a vast collection of images with Pixify!

Back to top

Roadmap

  • Inception Phase:

    • Project Planning
    • Research and Design
    • Documentation
  • Development Phase:

    • Frontend Development
    • Integration with Pixabay API
    • Image Cards and Pagination
  • Documentation and Testing:

    • Documentation and Testing
  • Post-Launch and Ongoing Development:

    • SimpleLightbox Integration
    • Notifications and User Feedback
    • Optimization and Performance
    • Infinite Scrolling

Back to top

Contributing

Contributions are welcome! If you have suggestions or improvements, feel free to fork the project, create a new branch, make your changes, and submit a pull request.

  1. Fork the Project
  2. Create your Feature Branch
    git checkout -b feature/NewFeature`
    
  3. Commit your Changes
    `git commit -m 'Add some NewFeature'`
  4. Push to the Branch
    `git push origin feature/NewFeature`
  5. Open a Pull Request

Back to top

Contact

Gmail Badge LinkedIn Badge Telegram Badge Instagram Badge

Back to top

Acknowledgments

Thank you to Pixabay for providing the API.

Back to top

About

Web application that allows users to search and display images using the Pixabay API.

https://valik3201.github.io/pixify/


Languages

Language:JavaScript 32.8%Language:CSS 32.0%Language:SCSS 26.4%Language:HTML 8.8%