An audiobook data aggregation API, combining multiple sources of data into one, consistent source.
Nexus - noun: a connection or series of connections linking two or more things.
Looking around for audiobook metadata, we realized there's no solid (or open) single source of truth. Further, some solutions had community curated data, only to close their API. As such, this project has been created to enable development to include multiple sources of audiobook content in one response.
This project also makes integration into existing media servers very streamlined. Since all data can be returned with 1-2 API calls, there's little to no overhead processing on the client side. This enables rapid development of stable client plugins. Audnexus serves as a provider during the interim of waiting for a community driven audiobook database, at which time audnexus will be a seeder for such a database.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
pnpm run
or pm2
ADP_TOKEN
and PRIVATE_KEY
, for chapters. You will need Python and audible
for this. More on that herepnpm install
from project directory to get dependenciesADP_TOKEN
and PRIVATE_KEY
environment variables as mentioned above if you are using the chapters endpoint.pnpm run watch-debug
to start the serverTest an API call with
http://localhost:3000/books/${ASIN}
Tests for this project use the Jest framework. Tests can be done locally in a dev environment:
pnpm test
After the tests have run, you may also browse the test coverage. This is generated in coverage/lcov-report/index.html
under the project directory.
API usage documentation can be read here: https://audnex.us/
Pre-rendered HTML documentation is also included in docs/index.html.
HTML can be re-generated from the spec, using:
pnpm run build-docs
Once you have Docker Swarm setup, grab the docker-compose.yml
from this repo, and use it to start the stack. Using something like Portainer for a Swarm GUI will make this much easier.
The stack defaults to 15 replicas for the node-server container. Customize this as needed.
Environment variables to add:
NODE_ADP_TOKEN
: Aforementioned ADP_TOKEN
valueNODE_MAX_REQUESTS
: Maximum amount of requests per 1 minute period from a single source (default 100)NODE_MONGODB_URI
: MongoDB connection URL, such as mongodb://mongo/audnexus
NODE_PRIVATE_KEY
: Aforementioned PRIVATE_KEY
valueNODE_REDIS_URL
: Redis connection URL, such as redis://redis:6379
NODE_UPDATE_INTERVAL
: Frequency (in days) to run scheduled update tasks (default 30). Update task is also run at startup.NODE_UPDATE_THRESHOLD
: Minimum number of days after an item is updated, to allow it to check for updates again (either scheduled or param).TRAEFIK_DOMAIN
: FQDN for the API serverTRAEFIK_EMAIL
: Email to register SSL cert withOnce the stack is up, test an API call with
https://${TRAEFIK_DOMAIN}/books/${ASIN}
Connect to the DB either from inside the mongodb container terminal or a MongoDB Compass/MongoSH session.
Switch to the correct DB:
use audnexus
Create the recommended indexes:
db.authors.createIndex( { asin: 1, region: 1 } )
db.books.createIndex( { asin: 1, region: 1 } )
db.chapters.createIndex( { asin: 1, region: 1 } )
db.authors.createIndex( { name: "text" } )