Skip to content

Latest commit

 

History

History
92 lines (72 loc) · 3.89 KB

README.md

File metadata and controls

92 lines (72 loc) · 3.89 KB

Consumet

Consumet API Rust

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

Discord Discord GitHub

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

Table of Contents

Installation

Locally

installation is simple.

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

$ git clone https://github.com/carrotshniper21/api.consumet.org
$ cd api.consumet.org
$ cargo build --release

start the server!

$ cargo run

Docker

Docker image is available at Docker Hub.

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

$ docker pull carrotshniper21/consumet-api
$ docker run -p 3000:3000 carrotshniper21/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.

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.

Showcases

Showcases are welcome! If you have a project that uses Consumet API, please let us know by making a new discussion here or by joining our Discord server. We will add your project to our showcases page.

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.rs via email, or join the discord server (Recommended).