https://github.com/beeequeue/arm-server
📃 A service for mapping Anime IDs between Database Websites
https://github.com/beeequeue/arm-server
anidb anilist anime anime-db api database kitsu mal metadata offline-database server
Last synced: about 1 month ago
JSON representation
📃 A service for mapping Anime IDs between Database Websites
- Host: GitHub
- URL: https://github.com/beeequeue/arm-server
- Owner: beeequeue
- License: agpl-3.0
- Created: 2019-01-26T22:21:43.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-11-19T03:55:57.000Z (6 months ago)
- Last Synced: 2024-11-24T19:42:07.897Z (6 months ago)
- Topics: anidb, anilist, anime, anime-db, api, database, kitsu, mal, metadata, offline-database, server
- Language: TypeScript
- Homepage: https://arm.haglund.dev/docs
- Size: 4.79 MB
- Stars: 97
- Watchers: 3
- Forks: 11
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# arm-server
[](https://github.com/BeeeQueue/arm-server/actions?query=branch%3Amaster+workflow%3ACI)
[](https://uptime.h.haglund.dev/status/arm-server)
This app uses data from [`Fribb/anime-lists`](https://github.com/Fribb/anime-lists) - fetching
and updating itself every 24 hours.
[`Fribb/anime-lists`](https://github.com/Fribb/anime-lists) is an automatic merged copy of
[`anime-offline-database`](https://github.com/manami-project/anime-offline-database)
and
[`Anime-Lists/anime-lists`](https://github.com/Anime-Lists/anime-lists).
#### Get notifications on important API changes
Subscribe to new releases in this repo:
### 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](https://github.com/BeeeQueue/arm-server/issues/new?template=manual-rule-request.md).
## [API Docs](https://arm.haglund.dev/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
1. Install dependencies - `pnpm`
1. Run database migrations - `pnpm migrate`
1. Download data (optional) - `pnpm fetch-data`
1. 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
1. Install dependencies - `pnpm`
1. Start the build - `pnpm docs:dev`
1. Open the file in a browser - `redoc-static.html`
1. Edit `docs/openapi.yaml` file