riimuru/consumet-api repository overview

⁠

⁠ Consumet API

Consumet provides an APIs for accessing information and links for various entertertainments like movies, books, anime, etc.

⁠ ⁠ ⁠ ⁠

Consumet scrapes data from various websites and provides APIs for accessing the data to satisfy your needs.

⁠ Table of Contents

• Installation⁠
  • Locally⁠
  • Docker⁠
  • Heroku⁠
• Documentation⁠
• Development⁠
• Provider Request⁠
• Support⁠
• Related repositories⁠

⁠Installation

⁠Locally

installation is simple.

Run the following command to clone the repository, and install the dependencies.

$ git clone https://github.com/consumet/consumet-api.git
$ cd consumet-api
$ npm install #or yarn install

start the server!

$ npm start #or yarn start

⁠Docker

Docker image is available at Docker Hub⁠.

run the following command to pull and run the docker image.

$ docker pull riimuru/consumet-api
$ docker run -p 3000:3000 riimuru/consumet-api

This will start the server on port 3000. You can access the server at http://localhost:3000/⁠, And can change the port by changing the -p option to -p <port>:3000.

You can add -d flag to run the server in detached mode.

⁠Heroku

Host your own instance of Consumet API on Heroku using the button below.

⁠Documentation

Please refer to the documentation⁠. Join our Discord server⁠ if you need any additional help or have any questions, comments, or suggestions.

⁠Development

Pull requests and stars are always welcome, for bugs and features create a new issue⁠. If you're brave to make make a commit to the project see CONTRIBUTING.md⁠.

⁠Provider Request

Make a new issue⁠ with the name of the provider on the title, as well as a link to the provider in the body paragraph.

⁠Support

You can contact the maintainers of consumet.ts via email⁠, or join the discord server⁠ (Recommended).

⁠Related repositories

⁠
• Consumet.ts⁠
• Website⁠
• Providers Status⁠