Hentai API

A versatile API that scrapes data from multiple providers, offering a wide range of content.

Providers

• Hentai Anime
  • HAnime
  • HentaiHaven
  • HentaiStream (planned)
  • HentaiFreak (planned)
  • Hentaimama (planned)
• Gallery/Fanmade
  • Rule34
• Hentai Manga
  • Hentai2Read (planned)
  • NHentai (planned)
  • HentaiFox (planned)

Installation

Ready to get started? Follow these simple steps to install and run the API on your machine:

Requirements

• Node.js 20.x or higher
• Bun 1.1.x or higher

Installation

First, clone the repository:

git clone https://github.com/shimizudev/hentai-api.git

Then, navigate to the project directory and install the dependencies:

cd hentai-api
bun install

Configuration

Create a .env file in the root directory of the project and add the following variables:

MONGODB_URL=mongodb://localhost:27017/hentai-api # Not required
# REDIS. You can use upstash redis for free. This is required for running the API. Will be optional in the future.
REDIS_HOST=localhost # Required.
REDIS_PASSWORD=password # Required

Running the API

To run the API in development mode, use the following command:

bun run dev # Will start a development server

Production Server

To run the API in production, you need to set the NODE_ENV variable in your .env file:

# ... rest of your env
NODE_ENV=production

Then, use the following command to start the production server:

bun run start # Will start a production server

The API will be accessible on port 3000 by default.

Docker Installation

Prefer Docker? Here's how to run the API using Docker:

Requirements

• Docker

Installation

First, clone the repository:

git clone https://github.com/shimizudev/hentai-api.git

Then, build the Docker image:

cd hentai-api
docker build -t hentai-api .

Configuration

Create a .env file in the root directory of the project and add the following variables:

MONGODB_URL=mongodb://localhost:27017/hentai-api
REDIS_HOST=localhost
REDIS_PASSWORD=password

Note: You can also pass these environment variables directly to the docker run command.

Running the API

To run the API using Docker, use the following command:

docker run -p 3000:3000 -d hentai-api

The API will be accessible on port 3000 by default.

Contributing

Contributions are highly appreciated! If you encounter any issues or have suggestions for improvements, please feel free to open an issue or submit a pull request on the GitHub repository.

License

This project is licensed under the Apache License 2.0. See the LICENSE file for more information.