Giter Site home page Giter Site logo

pexch / 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 421 KB

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

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

Shell 0.26% TypeScript 98.73% Dockerfile 1.01%

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)

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/
  5. Webshare (Optional) - You can get the free plan at https://www.webshare.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}
WEBSHARE_API_KEY={the API key for Webshare.io (Optional)}
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

Credit

api.enime.moe's People

Contributors

nadecancode avatar novasagittarii avatar riimuru avatar

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.