Skip to content

Fox Processor API - Universal Metadata Indexer For Anime In High Quality

Notifications You must be signed in to change notification settings

jeffsLM/fox-processor-api

Repository files navigation

Fox Anima Logo

Fox Anima - Fox Processor API

Universal Metadata Indexer For Anime In High Quality

Badge Badge Badge Badge

Badge Badge

⚠️DISCLAIMER: This project was created with educational objectives, which takes advantage of the lack of security of information passed between sites and from this can generate a unique and distributed indexing for TVS. Use of the project by third parties is neither recommended nor supported by repository owner.

FPA - Fox Processor API

FPA is a solution that centralizes, indexes and processes information about anime from different sources in order to provide episodes, images, summaries and all scalable information for viewing an anime without being tied to a single source.

Architectural Pattern

To create the FPA the link diagram below was used, it is possible to know how the project was structured as well as the use case that each route or helper would use:

Access in: https://whimsical.com/fox-anima-WEG53NZJCRLKqhCzW72Vvg@3CRerdhrAw8btSgM5wJ46k28

Define PORT aplication

by defalt, the port is 3333 but you can change it in the .env put PORT value

  //.env-file
  PORT=3333

Install and run FPA

 yarn install
 docker compose up

after running the command, you can run the migrations and popoulate the database with tables, with the command:

 yarn typeorm migrations:run

Project Pattern

FPA project is organized so that there are 5 encapsulators, namely:

  

⚠️DISCLAIMER: Due to the nature of the project being for educational purposes and because it takes advantage of flaws in third-party APIs. I cannot explain how failures happen, nor how their consumption can be carried out

  • /history - The history of user
  • /fox - Responsible for enabling queries of titles, episodes and more
  • /queue - Queue controller, allows you to add one or more items in batch for processing
  • /populate - Processes queue data with or without adding new titles

Related Projects

I also created an application that consumes FPA data and enables streaming on TVOS, check it out at: Fox Anima

Contributing

Feel like contributing? Fantastic! but at the moment this project is on pause, but feel free to open a PR

License

MIT © jeffsLM

About

Fox Processor API - Universal Metadata Indexer For Anime In High Quality

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages