Skip to content

Latest commit

 

History

43 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Giffin - A GIF & Sticker Search App

Live Demo

Giffin is a responsive web application that lets users search, browse, and explore GIFs and stickers using the Giphy API. It features a clean modern interface and seamless toggling between GIFs and stickers to enhance the user experience.

Giffin UI Preview


✨ Features

  • GIF & Sticker Search: Perform quick searches for your favorite GIFs and stickers.
  • Dynamic Toggles: Switch between GIFs and stickers with ease.
  • Responsive Design: Optimized for both desktop and mobile devices.
  • Scroll-to-Top Button: Quickly scroll back to the top of the page with a single click.
  • Modern Design: Minimalist dark-themed UI with vibrant accent colors.
  • Modal Navigation (Mobile): Access navigation options through a sleek modal on smaller devices.

🚀 Technologies Used

Technology Description
HTML5 Semantic structure and document layout.
SCSS/CSS3 Mobile-first responsive design using Grid and Flexbox.
JavaScript (ES6+) Modular logic using classes and modern syntax.
Axios Promise-based HTTP client for API requests (via CDN).
Font Awesome Iconography for navigation and UI elements.
Google Fonts Syne Mono for branding and Roboto for content.
Giphy API Integration to fetch high-quality GIFs and stickers.

📋 Prerequisites

Before you begin, ensure you have the following installed:

  • Node.js (v14 or higher recommended)
  • A modern web browser (Chrome, Firefox, Safari, Edge)

📦 Installation

To set up and run the project locally, follow these steps:

  1. Clone the Repository:

    git clone <repository-url>
    cd <repository-folder>
  2. Install Dependencies: This project uses Sass for styling. Install the compiler via NPM:

    npm install
  3. Compile SCSS (Optional): If you make changes to style.scss, you need to recompile it to style.css:

    npx sass css/style.scss css/style.css --watch
  4. Add Giphy API Key:

    • Register for a free Giphy API key.
    • In js/main.js, update the apiCall method with your key:
      const gifUrl = `https://api.giphy.com/v1/gifs/search?api_key=YOUR_API_KEY&q=${inputString}...`;
  5. Run Application: Open index.html in your browser or serve the application using a static server:

    npx http-server # or your preferred local server

💡 How to Use

  1. Search GIFs/Stickers: Use the search bar to look up content. Type your query and click the search icon.
  2. Switch States: Click the "GIFs" or "Stickers" buttons to toggle between search modes.
  3. Mobile Navigation: On small screens, click the hamburger menu to open the navigation modal.
  4. Scroll to Top: Use the floating arrow button (visible while scrolling) to return to the top of the page.

🎨 Design & Palette

Giffin features a "Cyber-Dark" aesthetic with high-contrast accent colors:

  • Background: #071013 (Deep Charcoal)
  • Primary Accent: #50FFB1 (Electric Mint)
  • Secondary Accent: #FCF300 (Vibrant Yellow)
  • Tertiary Accent: #CF1259 (Vivid Pink)

The UI is built with a Mobile-First approach, featuring specific breakpoints at 480px (grid layout for results) and 700px (desktop navigation).


👩‍💻 Code Structure

  • index.html: Application structure and layout using semantic HTML5.
  • css/style.scss: Modular styles with nested selectors and media queries.
  • js/main.js: Object-Oriented JavaScript implementation.
    • State Class: Manages UI interactions, navigation modals, and the "Scroll to Top" behavior.
    • Page Class: Handles search form submission, Giphy API communication, and dynamic rendering of results.

🤝 Contributing

Contributions are welcome! To make improvements:

  1. Fork the repository.
  2. Create a new branch for your feature/bugfix:
    git checkout -b feature/my-new-feature
  3. Commit your changes and push:
    git commit -m 'Add some feature'
    git push origin feature/my-new-feature
  4. Open a pull request.

📬 Contact


📜 License

This project is licensed under the MIT License.

About

Web application that allows users to search, browse, and interact with GIFs and stickers. Powered by the Giphy API, Giffin offers seamless navigation, quick search functionality, and a visually appealing user interface.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages