Skip to content

FireStreaker2/FemboyFinder

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FemboyFinder

Info

A simple image querier using express and image boorus, written with TypeScript.

This project was originally a way to find, as implied by the title, femboys. However, I also realized that since it queries by a tag name, it works for all things. Ex. you can search for not just femboys, but also other anime/manga characters.

Usage

You can get started by going to https://femboyfinder.firestreaker2.gq/${query}, where ${query} is your input. This will return either an image corresponding with the input, or an error message with a status of 500.

Ex. https://femboyfinder.firestreaker2.gq/astolfo.

API

FemboyFinder also provides an API for developers to use. At the core, it makes a GET request to the gelbooru api, gets a random link from it, and then sends it to the client within a JSON response.

Base URL: https://femboyfinder.firestreaker2.gq/api/${query}

Example

URL: https://femboyfinder.firestreaker2.gq/api/mihate_hiura

Response:

{
	"error": false,
	"query": "mihate_hiura",
	"url": "https://img3.gelbooru.com/images/2a/2b/2a2b656f0813ab2c29a86c3c69d15852.png",
	"tags": "1boy 2boys banjou_azusa black_hair blush crossdressing flower greyscale_with_colored_background hair_flower hair_ornament highres japanese_clothes kimono koisuru_(otome)_no_tsukurikata limited_palette looking_at_viewer male_focus midou_kenshirou mihate_hiura mixed-language_commentary multiple_boys pantyhose pink_eyes short_hair signature trap",
	"source": "https://www.pixiv.net/artworks/103958957"
}

Tag Searching

Tags are the basis of searching via the API, used commonly on many image booru sites. For specifically yande.re's, please refer to their documentation.

Selfhosting

If you for some reason would like to selfhost this project, the steps are simple. All you need is to have node and git installed already.

$ git clone https://github.com/FireStreaker2/FemboyFinder.git
$ cd FemboyFinder
$ npm i
$ npm start

If you are selfhosting a version of FemboyFinder prior to v1.0.3, you may need to set some extra environment variables

Contributing

If you would like to contribute, you can fork the repo and make a PR, or contact me via email @ suggestions@firestreaker2.gq

Credits

yande.re API
Gelbooru API

FemboyFinder versions prior to v1.0.3 were using Gelbooru. It has now been swapped to the yande.re as a result of API changes

License

MIT

About

Simple image querier using express and gelbooru

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors