Waifu Gallery

Waifu Gallery is a web application that serves as a repository for mostly anime-style images. It allows users to browse, search, and create their own collections that includes NSFW content, fan art, and more. The application features a user-friendly interface and offers several useful features.

• My fist time making a MD file, pls be nice

---

✨ Features

• API Access: Utilize the /api route for my own version of the waifu.pics API documentation.
• Contact Page: Reach out to the developers or provide feedback via the /contact page.
• Developer Tools: Access secret developer tools through the /rawr route.
• Responsive Design: Enjoy a seamless experience across desktops, tablets, and smartphones.
• Custom URL redirection: Allowes for the use of path like /api.

---

🚀 Live Website

Experience the application live at:
imduck42.github.io/Waifu-Gallery

---

🗂️ Repository Structure

Waifu-Gallery/
├── assets/                 # Image assets and static files
├── contact/                # Contact page resources
├── documentation/          # Additional documentation files
├── stuff/                  # Miscellaneous resources
├── 404.html                # Custom 404 error page (redirects to base)
├── app.js                  # Main JavaScript file for application logic
├── index.html              # Main HTML page
├── refactorlist.html       # List of refactoring tasks or updates
├── styles.css              # Stylesheet for the application

---

🔗 Routes and Endpoints

• / : Home page displaying the gallery.
• /api : API documentation and access.
• /contact : Contact page for user feedback and inquiries.
• /type/category : Quickly fetch images by specific categories.
• /rawr : Secret developer tools for advanced functionalities.

---

🛠️ Technologies Used

• HTML: Structure of the web pages.
• CSS: Styling and layout.
• JavaScript: Interactive functionality and API interactions.

---

📁 Custom Sources

Users can create custom image sources in the form of a .json file.
Learn more about how to use them in our documentation.

Example layout:

{
    "sourceInfo": [
        {
            "title": "Custom Source Template",
            "description": "A template for creating custom sources",
            "version": "69.42.0",
            "author": "ImDuck42(Creator)",
            "contact": "hu7ao on Discord"
        }
    ],

    "sfw": [
        {
            "category": "nature",
            "information": "Natural landscapes and wildlife",
            "images": [
                "https://example.com/nature1.mp4",
                "https://example.com/nature2.jpg"
            ]
        },
        {
            "category": "anime",
            "information": "Anime artwork and characters",
            "images": [
                "https://example.com/anime1.png",
                "https://example.com/anime2.webp"
            ]
        }
    ],
    "nsfw": [
        {
            "category": "adult Content",
            "information": "Explicit adult material",
            "images": [
                "https://example.com/nsfw1.jpg",
                "https://example.com/nsfw2.gif"
            ]
        },
        {
            "category": "sensitive",
            "information": "Other sensitive content",
            "images": [
                "https://example.com/sensitive1.jpg",
                "https://example.com/sensitive2.mov"
            ]
        }
    ]
}

• Custom sources are saved in local storage and if imported, allowes for the usage of direct URL's for all users having the same Source name and category
  • https://imduck42.github.io/Waifu-Gallery/type/Source%20Name:Category
  • (%20 for spaces)

---

🔧 Getting Started

To set up the project locally:

1. Clone the repository:

   git clone https://github.com/ImDuck42/Waifu-Gallery.git

2. Navigate to the project directory:

   cd Waifu-Gallery

3. Open index.html in your preferred web browser.

---

For any further questions or support, please visit the contact page.