docs: add documentation and update endpoint list

sinkaroid · Apr 18, 2023 · 2f515e0 · 2f515e0
1 parent ce7c402
commit 2f515e0
Showing 1 changed file with 280 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,280 @@
+<div align="center">
+<a href="https://lust.scathach.id"><img width="500" src="https://cdn.discordapp.com/attachments/1046495201176334467/1097683154959077496/lust-node_1.png" alt="lustpress"></a>
+
+<h4 align="center">RESTful and experimental API for the PornHub and other adult videos</h4>
+<p align="center">
+	<a href="https://github.com/sinkaroid/lustpress/actions/workflows/playground.yml"><img src="https://github.com/sinkaroid/lustpress/workflows/Playground/badge.svg"></a>
+	<a href="https://codeclimate.com/github/sinkaroid/lustpress/maintainability"><img src="https://api.codeclimate.com/v1/badges/29a2be78f853f9e3a4a3/maintainability" /></a>
+</p>
+
+Lustpress stand for Lust and **Express**, rebuild from [Jandapress](https://github.com/sinkaroid/jandapress) with completely different approach.
+The motivation of this project is to bring you an actionable data related to pornhub and other adult videos with gather, similar design pattern, endpoint bindings and consistent structure in mind.
+
+<a href="https://sinkaroid.github.io/lustpress">Playground</a> •
+<a href="https://github.com/sinkaroid/lustpress/blob/master/CONTRIBUTING.md">Contributing</a> •
+<a href="https://github.com/sinkaroid/lustpress/issues/new/choose">Report Issues</a>
+</div>
+
+---
+
+<a href="https://lust.scathach.id"><img align="right" src="https://cdn.discordapp.com/attachments/1046495201176334467/1097687929456963685/lp.png" width="320"></a>
+
+- [Lustpress](#)
+  - [The problem](#the-problem)
+  - [The solution](#the-solution)
+  - [Features](#features)
+    - [Lustpress avaibility](#lustpress-avaibility)
+  - [Prerequisites](#prerequisites)
+    - [Installation](#installation)
+      - [Docker](#docker)
+      - [Manual](#manual)
+    - [Running tests](#running-tests)
+  - [Playground](https://sinkaroid.github.io/lustpress)
+    - [Routing](#playground)
+    - [Status response](#status-response)
+  - [CLosing remarks](https://github.com/sinkaroid/lustpress/blob/master/CLOSING_REMARKS.md)
+    - [Alternative links](https://github.com/sinkaroid/lustpress/blob/master/CLOSING_REMARKS.md#alternative-links)
+  - [Pronunciation](#Pronunciation)
+  - [Client libraries / Wrappers](#client-libraries--wrappers)
+  - [Acknowledgements](#acknowledgements)
+  - [Legal](#legal)
+
+
+## The problem
+Even official API is exists, they were lack and bad behavior, every single site has own structure and different way to interacts with.
+Instead making lot of abstraction and enumerating them manually, You can rely on lustpress to make less of pain. The current state is FREE to use, all anonymous usage is allowed no authentication and CORS enabled.
+
+## The solution
+Don't make it long, make it short, all processed through single rest
+<a href="https://sinkaroid.github.io/lustpress"><img src="https://cdn.discordapp.com/attachments/938964058735013899/1097780378061766697/glow.png" width="800"></a>
+
+## Features
+
+- Ratelimiting and throttling
+- Gather the most adult videos on the internet
+- Objects taken are consistent structure
+- Objects taken is re-appended to make extendable
+- All in one: get, search, and random methods
+- In the future we may implement JWT authentication
+- Pure scraping, does not hit the API (if exists)
+
+## Lustpress avaibility
+**Features availability** that Lustpress has
+| Site            | Status                                                                                                                                                                            | Get | Search | Random | Related |
+| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | ------ | ------ | ------- |
+| `pornhub`       | [![pornhub](https://github.com/sinkaroid/lustpress/workflows/Pornhub%20test/badge.svg)](https://github.com/sinkaroid/lustpress/actions/workflows/pornhub.yml)                   | `Yes`  | `Yes`     | `Yes`     | `Yes`     |
+| `xnxx`       | [![xnxx](https://github.com/sinkaroid/lustpress/workflows/Xnxx%20test/badge.svg)](https://github.com/sinkaroid/lustpress/actions/workflows/xnxx.yml)                  | `Yes`  | `Yes`     | `Yes`     | `Yes`     |
+| `redtube`     | [![redtube](https://github.com/sinkaroid/lustpress/workflows/Redtube%20test/badge.svg)](https://github.com/sinkaroid/lustpress/actions/workflows/redtube.yml)             | `Yes`  | `Yes`     | `Yes`     | `Yes`     |
+| `xvideos`   | [![xvideos](https://github.com/sinkaroid/lustpress/workflows/Xvideos%20test/badge.svg)](https://github.com/sinkaroid/lustpress/actions/workflows/xvideos.yml)       | `Yes`  | `Yes`     | `Yes`      | `Yes`     |
+| `xhamster` | [![xhamster](https://github.com/sinkaroid/lustpress/workflows/Xhamster%20test/badge.svg)](https://github.com/sinkaroid/lustpress/actions/workflows/xhamster.yml) | `Yes`  | `Yes`      | `Yes`      | `Yes`     |
+| `youporn`     | [![youporn](https://github.com/sinkaroid/lustpress/workflows/Youporn%20test/badge.svg)](https://github.com/sinkaroid/lustpress/actions/workflows/youporn.yml)            | `Yes`  | `Yes`     | `Yes`     | `Yes`     |
+
+## Prerequisites
+<table>
+	<td><b>NOTE:</b> NodeJS 14.x or higher</td>
+</table>
+
+To handle several requests from each website, You will also need [Redis](https://redis.io/) for persistent caching, free tier is available on [Redis Labs](https://redislabs.com/), You can also choose another adapters as we using [keyv](https://github.com/jaredwray/keyv) Key-value storage with support for multiple backends. When you choosing your own adapter, all data must be stored with `<Buffer>` type.
+
+## Installation
+Rename `.env.schema` to `.env` and fill the value with your own
+
+```bash
+# railway, fly.dev, heroku, vercel or any free service
+RAILWAY = sinkaroid
+
+# default port
+PORT = 3000
+
+# backend storage, default is redis, if not set it will consume memory storage
+REDIS_URL = redis://default:somenicepassword@redis-666.c10.us-east-6-6.ec666.cloud.redislabs.com:1337
+
+# ttl expire cache (in X hour)
+EXPIRE_CACHE = 1
+
+# you must identify your origin, if not set it will use default
+USER_AGENT = "lustpress/1.6.1 Node.js/16.9.1"
+```
+
+### Docker
+
+    docker pull ghcr.io/sinkaroid/lustpress:latest
+    docker run -p 3000:3000 -d ghcr.io/sinkaroid/lustpress:latest
+
+### Docker (your own)
+```bash
+docker run -d \
+  --name=lustpress \
+  -p 3000:3000 \
+  -e REDIS_URL='redis://default:somenicepassword@redis-666.c10.us-east-6-6.ec666.cloud.redislabs.com:1337' \
+  -e EXPIRE_CACHE='1' \
+  -e USER_AGENT='lustpress/1.0.5 Node.js/16.9.1' \
+  ghcr.io/sinkaroid/lustpress:latest
+```
+
+### Manual
+
+    git clone https://github.com/sinkaroid/lustpress.git
+
+- Install dependencies
+  - `npm install / yarn install`
+- Lustpress production
+  - `npm run start:prod`
+- Lustpress testing and hot reload
+  - `npm run start:dev`
+
+## Running tests
+Lustpress testing
+
+### Start the production server
+`npm run start:prod`
+
+### Running development server
+`npm run start:dev`
+
+### Check the whole sites, It's available for scraping or not
+`npm run test`
+
+> To running other tests, you can see object scripts in file `package.json`
+
+## Playground
+https://sinkaroid.github.io/lustpress
+
+- These `parameter?`: means is optional
+
+- `/` : index page
+
+### PornHub
+The missing piece of pornhub.com - https://sinkaroid.github.io/lustpress/#api-pornhub
+- `/pornhub` : pornhub api
+  - **get**, takes parameters : `id`
+  - **search**, takes parameters : `key`, `?page`, `?sort`
+  - **related**, takes parameters : `id`
+  - **random**
+  - <u>sort parameters on search</u>
+    - "mr", "mv", "tr", "lg"
+  - Example
+    - https://lust.scathach.id/pornhub/get?id=ph63c4e1dc48fe7
+    - https://lust.scathach.id/pornhub/search?key=milf&page=2&sort=mr
+    - https://lust.scathach.id/pornhub/related?id=ph63c4e1dc48fe7
+    - https://lust.scathach.id/pornhub/random
+
+### Xnxx
+The missing piece of xnxx.com - https://sinkaroid.github.io/lustpress/#api-xnxx
+- `/xnxx` : xnxx api
+  - **get**, takes parameters : `id`
+  - **search**, takes parameters : `key`, `?page`, and TBD
+  - **related**, takes parameters : `id`
+  - **random**
+  - <u>sort parameters on search</u>
+    - TBD
+  - Example
+    - https://lust.scathach.id/xnxx/get?id=video-17vah71a/makima_y_denji
+    - https://lust.scathach.id/xnxx/search?key=bbc&page=2
+    - https://lust.scathach.id/xnxx/related?id=video-17vah71a/makima_y_denji
+    - https://lust.scathach.id/xnxx/random
+
+### RedTube
+The missing piece of redtube.com - https://sinkaroid.github.io/lustpress/#api-redtube
+- `/redtube` : redtube api
+  - **get**, takes parameters : `id`
+  - **search**, takes parameters : `key`, `?page`, and TBD
+  - **related**, takes parameters : `id`
+  - **random**
+  - <u>sort parameters on search</u>
+    - TBD
+  - Example
+    - https://lust.scathach.id/redtube/get?id=42763661
+    - https://lust.scathach.id/redtube/search?key=asian&page=2
+    - https://lust.scathach.id/redtube/related?id=42763661
+    - https://lust.scathach.id/redtube/random
+
+### Xvideos
+The missing piece of xvideos.com - https://sinkaroid.github.io/lustpress/#api-xvideos
+- `/xvideos` : xvideos api
+  - **get**, takes parameters : `id`
+  - **search**, takes parameters : `key`, `?page`, and TBD
+  - **related**, takes parameters : `id`
+  - **random**
+  - <u>sort parameters on search</u>
+    - TBD
+  - Example
+    - https://lust.scathach.id/xvideos/get?id=video73564387/cute_hentai_maid_with_pink_hair_fucking_uncensored_
+    - https://lust.scathach.id/xvideos/search?key=hentai&page=2
+    - https://lust.scathach.id/xvideos/related?id=video73564387/cute_hentai_maid_with_pink_hair_fucking_uncensored_
+    - https://lust.scathach.id/xvideos/random
+
+### Xhamster
+The missing piece of xhamster.com - https://sinkaroid.github.io/lustpress/#api-xhamster
+- `/xhamster` : xhamster api
+  - **get**, takes parameters : `id`
+  - **search**, takes parameters : `key`, `?page`, and TBD
+  - **related**, takes parameters : `id`
+  - **random**
+  - <u>sort parameters on search</u>
+    - TBD
+  - Example
+    - https://lust.scathach.id/xhamster/get?id=videos/horny-makima-tests-new-toy-and-cums-intensely-xhAa5wx
+    - https://lust.scathach.id/xhamster/search?key=arab&page=2
+    - https://lust.scathach.id/xhamster/related?id=videos/horny-makima-tests-new-toy-and-cums-intensely-xhAa5wx
+    - https://lust.scathach.id/xhamster/random
+
+### YouPorn
+The missing piece of youporn.com - https://sinkaroid.github.io/lustpress/#api-youporn
+- `/youporn` : youporn api
+  - **get**, takes parameters : `id`
+  - **search**, takes parameters : `key`, `?page`, and TBD
+  - **related**, takes parameters : `id`
+  - **random**
+  - <u>sort parameters on search</u>
+    - TBD
+  - Example
+    - https://lust.scathach.id/youporn/get?id=16621192/chainsaw-man-fuck-makima-3d-porn-60-fps
+    - https://lust.scathach.id/youporn/search?key=teen&page=2
+    - https://lust.scathach.id/youporn/related?id=16621192/chainsaw-man-fuck-makima-3d-porn-60-fps
+    - https://lust.scathach.id/youporn/random
+
+### JavHD
+The missing piece of javhd.com - TBA
+- `/javhd` : javhd api
+  - **get**, takes parameters : TBD
+  - **search**, takes parameters : TBD
+  - **related**, takes parameters : TBD
+  - **random**
+  - <u>sort parameters on search</u>
+    - TBD
+  - Example
+    - TBD
+
+
+## Status response
+`"success": true,` or `"success": false,`
+
+    HTTP/1.1 200 OK
+    HTTP/1.1 400 Bad Request
+    HTTP/1.1 500 Fail to get data
+
+## Frequently asked questions 
+**Q: The website response is slow**  
+> That's unfortunate, This repository was opensource already, You can host and deploy Lustpress with your own instance. Any fixes and improvements will updating to this repo.
+
+**Q: I dont want to host my own instance**   
+> That's unfortunate, Hit the "Sponsor this project" button, any kind of donations will helps me to funding the development.
+
+## Pronunciation
+`en_US` • **/lʌstˈprɛs/** — "lust" stand for this project and "press" for express.
+
+
+## Client libraries / Wrappers
+Seamlessly integrate with the languages you love, simplified the usage, and intelisense definitions on your IDEs
+
+- TBD
+- Or [create your own](https://github.com/sinkaroid/lustpress/edit/master/README.md)
+
+## Acknowledgements
+I thank you to all the [Scathach's supporter](https://scathachbot.xyz/about) who made this project exists :gajah_ngecrot:
+
+## Legal
+This tool can be freely copied, modified, altered, distributed without any attribution whatsoever. However, if you feel
+like this tool deserves an attribution, mention it. It won't hurt anybody.
+> Licence: WTF.