Skip to content

victorgveloso/MicoLeaoDubladoAPI

Repository files navigation

Mico Leão Dublado API

Mico Leão Dublado Logo

Automated tests Check test server health Publish Typedoc to Github Pages codecov

Mico Leão Dublado is a stateful service for multimedia's torrent magnet storage. Relying on MongoDB the magnets are stored in accordance with the Stremio's standards. Adding and searching content is straightforward and it is described further at Section Using.

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code.

Dependencies

  • NodeJS
  • TypeScript
  • Docker (with docker-compose)

Running

  • Run:
make start # to start
make test # to run automated tests
make clean # to delete data, cache and docker image
make # to run all three commands in the order: clean -> test -> start

Using

Mico Leão Dublado API is a HTTP API (use an HTTP client of your choice).

Entrypoints

Verb path request body request example response example response model
GET /manifest.json X X /src/persistence/models/stub/manifest.json /src/persistence/models/manifest.ts
GET /stream/series/{imdbId}:{season}:{episode}.json X X /src/persistence/models/stub/stream.json /src/persistence/models/stream.ts
GET /meta/series/{imdbId}.json X X /src/persistence/models/stub/meta.json /src/persistence/models/meta.ts
GET /catalog/series/{imdbId}/{extra?}.json X X /src/persistence/models/stub/catalog.json /src/persistence/models/catalog.ts
GET /stream/movie/{imdbId}.json X X /src/persistence/models/stub/stream.json /src/persistence/models/stream.ts
GET /meta/movie/{imdbId}.json X X /src/persistence/models/stub/meta.json /src/persistence/models/meta.ts
GET /catalog/movie/{imdbId}/{extra?}.json X X /src/persistence/models/stub/catalog.json /src/persistence/models/catalog.ts
POST /movie /src/persistence/models/transfer-objects/movie.ts /src/persistence/models/stub/movie.json X X
POST /series /src/persistence/models/transfer-objects/series.ts /src/persistence/models/stub/series.json X X

Contributing

If you are interested in reporting/fixing issues and contributing directly to the code base, please see CONTRIBUTING.md for more information on what we're looking for and how to get started.

Reference

You might be interested in the Mico Leão Dublados API's reference documentation. It is hosted using Github Pages and it is available here.

Community

You might find us in the StremioAddons Discord Server and in r/StremioAddons.

License: Apache

About

Movies and Series addon API (compatible with Stremio)

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published