netrunnerdb-api-server

API Server for NetrunnerDB

Status & Timeline

This is experimental for now, but will be the seed for v2 of NRDB.

Public API functionality will be implemented first as v3 of the existing NRDB API.

Dependencies

This depends on the data from https://github.com/NetrunnerDB/netrunner-cards-json.

The netrunner-cards-json is expected to be next to the folder with this repository and accessible at ../netrunner-cards-json to the application.

For dev in VS Code.

This repository has a Devcontainer setup. To use it, first copy the database.yml file.

cp config/database.example.yml config/database.yml

If you open this folder in VS Code it should prompt you to use the devcontainer.

For local dev with docker

If you have a device with apple silicon, do the following first (adapt the platform based on your device and error message):

export DOCKER_DEFAULT_PLATFORM=linux/arm64/v8

echo "RAILS_ENV=development" > .env
cp config/database.example.yml config/database.yml
docker network create null_signal
docker compose build
docker compose -f docker-compose.yml -f docker-compose.override.init.yml up -d

Wait until docker compose logs nrdb_api_server | tail shows Listening on http://0.0.0.0:3000.

Test that http://localhost:3000/api/docs/ loads in your browser. Afterwords,

docker compose up -d

Is enough to spin up the containers, unless you want to restart the db from scratch (use the above example with init.yml)

To run tests in your docker container, you will need to override the environment, like so:

docker compose exec -e RAILS_ENV=test nrdb_api_server rails test

Getting Started

Once your server is running you can hit the api! ex. http://localhost:3000/api/v3/public/cards/sure_gamble

You can find the full list of routes here: http://localhost:3000/rails/info/routes

API Documentation will be available at http://localhost:3000/api/docs/.

Run RAILS_ENV=test bundle exec rails db:reset with docker compose run or in a shell in the container to load the fixture data for the tests.

To re-generate API documentation (in test environment to ensure minimal changes) run:

docker compose run -e RAILS_ENV=test nrdb_api_server bundle exec rake docs:generate

Tasks

If you are using docker, ensure that you are in a shell for the container before running these tasks.

Importing Cards

To import cards from the netrunner-cards-json repository, first ensure that it is checked out next to this directory, then run:

bundle exec rake cards:import

Importing Decklists

To import decklists from NRDB Classic, use

bundle exec rake import_decklists:import[2024-11-09]