Skip to content

Latest commit

 

History

History
59 lines (38 loc) · 2.16 KB

README.md

File metadata and controls

59 lines (38 loc) · 2.16 KB
Raw

arm-server

This app uses data from Fribb/anime-lists - fetching and updating itself every 24 hours.

Fribb/anime-lists is an automatic merged copy of anime-offline-database and Anime-Lists/anime-lists.

Get notifications on important API changes

Subscribe to new releases in this repo:

image

Missing or duplicate entries

Some entries in the database are not mapped correctly due to inconsistent naming - the owner of anime-offline-database cannot fix them due to complexity. Therefore this service has manual rules that combines known failures.

You can help add rules by submitting a manual rule request.

API Docs

Self-hosting

Docker images are built and provided for each commit on master!

The minimum configuration needed can be found in the following command:

docker run -it --name arm-server -p 3000:3000 ghcr.io/beeequeue/arm-server:latest

Development

Server

  1. Clone the project
  2. Install dependencies - pnpm
  3. Run database migrations - pnpm migrate
  4. Download data (optional) - pnpm fetch-data
  5. Start the server - pnpm dev

If the database connection fails double check that your NODE_ENV is set to development.

Docs

  1. Clone the project
  2. Install dependencies - pnpm
  3. Start the build - pnpm docs:dev
  4. Open the file in a browser - redoc-static.html
  5. Edit docs/openapi.yaml file