Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/consumet/api.consumet.org
A Modern Search Engine API for Anime, Movies/TVShows, Books, Light Novels, Manga, etc.
https://github.com/consumet/api.consumet.org
anilist anime anime-api api books books-api comics comics-api light-novels lightnovel-api manga manga-api movies movies-api rest-api scraper search-engine streaming streaming-api typescript
Last synced: about 2 months ago
JSON representation
A Modern Search Engine API for Anime, Movies/TVShows, Books, Light Novels, Manga, etc.
- Host: GitHub
- URL: https://github.com/consumet/api.consumet.org
- Owner: consumet
- License: gpl-3.0
- Created: 2022-05-22T17:04:23.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-24T16:42:12.000Z (about 2 months ago)
- Last Synced: 2024-07-24T19:24:04.566Z (about 2 months ago)
- Topics: anilist, anime, anime-api, api, books, books-api, comics, comics-api, light-novels, lightnovel-api, manga, manga-api, movies, movies-api, rest-api, scraper, search-engine, streaming, streaming-api, typescript
- Language: TypeScript
- Homepage: https://docs.consumet.org
- Size: 1.28 MB
- Stars: 1,023
- Watchers: 27
- Forks: 449
- Open Issues: 42
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Consumet API
Consumet provides an APIs for accessing information and links for various entertainments 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](#installation)
- [Locally](#locally)
- [Docker](#docker)
- [Heroku](#heroku)
- [Vercel](#vercel)
- [Render](#render)
- [Railway](#railway)
- [Documentation](#documentation)
- [Development](#development)
- [Showcases](#showcases)
- [Provider Request](#provider-request)
- [Support](#support)
- [Contributors ✨](#contributors-)
- [Related repositories](#related-repositories)
## Installation
### Locally
installation is simple.
Run the following command to clone the repository, and install the dependencies.
```sh
$ git clone https://github.com/consumet/api.consumet.org.git
$ cd api.consumet.org
$ npm install #or yarn install
```
start the server!
```sh
$ npm start #or yarn start
```
### Docker
Docker image is available at [Docker Hub](https://hub.docker.com/r/riimuru/consumet-api).
run the following command to pull and run the docker image.
```sh
$ 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 :3000`.
Be sure to set `NODE_ENV` to `PROD` in your environment variables when running your own instance.
Check out the `.env.example` file for more information.
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.
[](https://heroku.com/deploy?template=https://github.com/consumet/api.consumet.org/tree/main)
### Vercel
Host your own instance of Consumet API on Vercel using the button below.
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fconsumet%2Fapi.consumet.org)
### Render
Host your own instance of Consumet API on Render using the button below.
[](https://render.com/deploy?repo=https://github.com/consumet/api.consumet.org)
### Railway
Host your own instance of Consumet API on Railway using the button below.
[](https://railway.app/new/template/C0FwuP?referralCode=dv4TuD)
## Documentation
Please refer to the [documentation](https://docs.consumet.org). Join our [Discord server](https://discord.gg/qTPfvMxzNH) 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](https://github.com/consumet/api.consumet.org/issues). If you're brave to make make a commit to the project see [CONTRIBUTING.md](https://github.com/consumet/consumet.ts/blob/master/docs/guides/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](https://github.com/consumet/api.consumet.org/discussions/categories/show-and-tell) or by joining our [Discord server](https://discord.gg/qTPfvMxzNH). We will add your project to our [showcases page](https://consumet.org/showcase).
## Provider Request
Make a new [issue](https://github.com/consumet/consumet.ts/issues/new?assignees=&labels=provider+request&template=provider-request.yml) 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](mailto:[email protected]), or [join the discord server](https://discord.gg/qTPfvMxzNH) (Recommended).
## Contributors ✨
Thanks to the following people for keeping this project alive and thriving.
[](https://github.com/consumet/consumet.ts/graphs/contributors)
## Related repositories
- [Consumet.ts](https://github.com/consumet/consumet.ts)
- [Website](https://github.com/consumet/consumet.org)
- [Providers Status](https://github.com/consumet/providers-status)