GithubHelp home page GithubHelp logo

nhatduypham1993 / api.enime.moe Goto Github PK

View Code? Open in Web Editor NEW

This project forked from adithyannellickal/api.enime.moe

0.0 0.0 0.0 864 KB

An API service for developers to quickly access the anime info and sources

Home Page: https://docs.enime.moe

License: GNU General Public License v3.0

Shell 0.13% JavaScript 1.83% TypeScript 97.12% PLpgSQL 0.39% Dockerfile 0.52%

api.enime.moe's Introduction

Enime API

Enime API is an open source API service for developers to access anime info (as well as their video sources)

"Buy Me A Coffee"

Installation

Prerequisites

To deploy Enime API, you need following services:

  1. Redis - You can get a free hosting at https://upstash.com/
  2. PostgresSQL - You can get a free hosting at https://planetscale.com/
  3. Node.js (>=v16) - You can install it at https://nodejs.org/en/download/
  4. Pnpm - You can install it at https://pnpm.io/

Steps

  1. Install dependencies with pnpm install
  2. Create a .env file at the root of the project with the following properties:
PORT={the port that application is going to run on}
DATABASE_URL={the postgres database connection url}
REDIS_HOST={Redis host}
REDIS_PORT={Redis port}
REDIS_PASSWORD={Redis password}
  1. Initialize prisma with pnpm prisma:generate
  2. Run pnpm run dev and the application will start at desginated port (default 3000 if not explicitly set)

Docker

  1. Run docker pull enime/api:1.0
  2. Plug the environment variables in (If you don't know how to do this please Google)

Docker-Compose

  1. Refer to docker-compose.yml in the project root to proceed

Support

  • We use Discord for quick suggestions & bug reports, please join here

FAQ

  • Do you download the videos yourself / is your API subject to DMCA compliant
    • No, Enime API never downloads the video from any source provider, only link will be returned from the response hence it is completely not subject to DMCA compliant

Performance

  • Enime API tries to only scrape anime that has necessity of being scraped through a semi-sophisticated algorithm, resulting in its capacity to keep track of thousands of anime at the same time with high performance.
    • On average, Enime API only uses ~800MB of RAM (spikes to ~2.5GB when intensively scraping) and <15% of CPU (80% when intensively scraping) while keeping track of ~2000 anime

Credit

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.